Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

26 lines (22 loc) · 1.94 KB

Contribution Guidelines

Contributions are welcome.

Ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure your contribution is useful before submitting.
  • Make an individual pull request for each suggestion.
  • Use the following format: [title](link) - Description.
  • Additions should be added to the end of the relevant category.
  • New categories, or improvements to the existing categorization are welcome.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request should have a useful title and include a link to the package and why it should be included.
  • We use badges:
    • Code quality: Golden for popular and battle tested packages ![Code quality: golden](https://img.shields.io/badge/code%20quality-golden-yellow.svg)
    • Not maintained for packages that are no longer actively maintained ![Not maintained](https://img.shields.io/badge/Maintained%3F-no-red.svg)
    • Speed: Blazing for packages with exceptional performance ![Speed: Blazing](https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-brightgreen.svg)
    • Size: Tiny for packages that have a tiny footprint ![Size: Tiny](https://img.shields.io/badge/size-tiny-blue.svg)
    • Packages that no longer work or should not be recommended for whatever reasons will be removed. They have no badge. Please indicate the reasons for removal in the pull request.
    • Feel like we need more badges? Make a pull request!

Thank you for your help!