Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.53 KB

contributing.md

File metadata and controls

28 lines (21 loc) · 1.53 KB

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:

  • Search previous suggestions before making a new one, as yours may be a duplicate
  • Suggested packages should be tested and documented
  • Make an individual pull request for each suggestion
  • Use the following format: [package](link) - Description.
  • Additions should be added to the bottom of the relevant category
  • 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
  • New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request

Thank you for your suggestion!

Submitting a Pull Request

  • Non-trivial changes are often best discussed in an issue first, to prevent you from doing unnecessary work
  • Use a descriptive title for the pull request and commits
  • You might be asked to do changes to your pull request, you can do that by just updating the existing one

Contributing.md based on the one of https://github.com/sindresorhus/awesome-nodejs