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.
The pull request should have a useful title. Pull requests with update README.md
as title will be closed right away because I’m so tired of nobody reading this document. Please carefully read everything in Adding to this list
.
Table of Contents
Adding to this list
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- If you just created something, wait at least a couple of weeks before submitting.
- You should of course have read or used the thing you’re submitting.
- Make an individual pull request for each suggestion.
- Use title-casing (AP style).
- Use the following format:
[package](link) - Description
- Link additions should be added to the bottom of the relevant category.
- Link to the GitHub repo, not npmjs.com.
- Don’t mention
Node.js
in the description as it’s implied. - New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.
- 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 and commit should have a useful title and include a link to the package and why it should be included.
- The body of your commit message should contain a link to the repository.
Thank you for your suggestions!
Updating your Pull Request
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 write up on how to change a Pull Request, and the different ways you can do that.