Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

24 lines (19 loc) · 1.75 KB

Contribution Guidelines

Ensure your pull request adheres to the following guidelines:

  • If you just created something, wait at least 30 days before submitting. This is to give it some time to mature and ensure it's not just a publish-and-forget type of project.
  • Keep in mind that the list is very mature by now, so the bar of getting something accepted is high. Only submit something unique and generally useful.
  • If you submit a project that is similar to an existing project in the list, argue how it's better.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make an individual pull request for each suggestion.
  • Use the following format: [Title](link) [`repo`](repo-link) — Description.
  • Additions should be added to the relevant category, which is sorted alphabetically.
  • Keep descriptions short and simple, but descriptive.
  • Start the description with a capital and end with a full stop/period.
  • Don't start the description with A or An.
  • 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.
  • New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.

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. 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.