Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.89 KB

contributing.md

File metadata and controls

29 lines (22 loc) · 1.89 KB
Raw

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Ensure your pull request adheres to the following guidelines:

  • The submitted project should be more than 30 days old and the repo should have at least 40 stars.
  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • If you submit a project that is similar to an existing project in the list, argue how it's better.
  • You should of course have read/used the thing you're submitting.
  • Make an individual pull request for each suggestion.
  • Suggested packages should be tested and documented.
  • Use the following format: [name](link) - Description.
  • 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.
  • Link additions should be added to the bottom of the relevant section.
  • New categories or improvements to the existing categorization are welcome.
  • Pull requests should have a useful title and include a link to the package and why it should be included.

Thank you for your suggestion!

Updating your PR

A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, here is a guide on the different ways you can update your PR so that we can merge it.