Skip to content

Latest commit

 

History

History
71 lines (55 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

71 lines (55 loc) · 2.95 KB

Contribution Guidelines


Eligibility

A project is eligible to be added to this list if it is:

  • Awesome! 😎
    • Research if the stuff you're including is actually awesome.
    • Only put stuff on the list that you or another contributor can personally recommend.
    • You should rather leave stuff out than include too much.
  • Well-documented (wiki, descriptive README.md, javadocs or command-line help available).
  • Open-source with a free license.
  • Actively maintained (no dead projects!).

Entry Additions

  1. Make sure the entry is eligible for this list.
  2. Click on the pen icon at the top of the README.
  3. Add the entry such that it respects alphabetical order within its parent category. It should use the following convention with a SPDX License Identifier:
Wiki Available Markdown Format
✔️
[Project Name](Source Link) - Description. ([Wiki](Wiki Link)) SPDX License Identifier

[Project Name](Source Link) - Description. SPDX License Identifier
  1. In the description box at the bottom of the page, state what you added.
  2. Propose the changes and open a pull request.

Category & Subcategory Additions

When creating new entries, it may be necessary to create a new category to logcally sort the entry under.

  1. Make sure there is no existing category underneath one of the main categories that could logically contain the entry.
  2. Click on the pen icon at the top of the README.
  3. Add the category such that it respects alphabetical order amongst the other subcategories. It should use the following convention:
Category Depth Markdown Format
1 Child
### Library Category Name
2 Grandchild
(Child of Child)

#### Library Subcategory Name
  1. In the description box at the bottom of the page, state what you added.
  2. Propose the changes and open a pull request.