Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

21 lines (16 loc) · 1.27 KB
Raw

CONTRIBUTING

Please ensure your pull request adheres to the following guidelines:

  • Additions should be added alphabetically to the relevant category.
  • Check your spelling and grammar.
  • Keep descriptions short and simple, but descriptive.
  • Make an individual pull request for each suggestion.
  • Make sure your text editor is set to remove trailing whitespace.
  • New categories, or improvements to the existing categorization are welcome.
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Start the description with a capital and end the sentence (including links) with a full stop/period.
  • Suggested packages should be tested and documented.
  • The pull request should have a useful title and include a link to the package and why it should be included.
  • Use the following format: [package](link) - Description.

Thank you for your suggestions!

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.