1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome-nodejs.git synced 2024-11-20 11:27:17 -05:00
nodejs/contributing.md

20 lines
974 B
Markdown
Raw Normal View History

2014-07-11 09:34:45 -04:00
# Contribution Guidelines
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
2014-07-11 12:07:35 -04:00
- Suggested packages should be tested and documented.
2014-07-11 09:34:45 -04:00
- Make an individual pull request for each suggestion.
2014-07-11 12:07:35 -04:00
- Use the following format: `[package](link) - Description.`
- Additions should be added to the bottom of the relevant category.
2014-07-11 09:34:45 -04:00
- New categories, or improvements to the existing categorization are welcome.
2015-10-05 12:50:36 -04:00
- Link to the GitHub repo, not npmjs.com.
2014-07-11 12:07:35 -04:00
- Keep descriptions short and simple, but descriptive.
2014-07-29 09:10:09 -04:00
- Don't mention `Node.js` in the description as it's implied.
- Start the description with a capital and end with a full stop/period.
2014-07-11 09:34:45 -04:00
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
2015-01-09 10:41:23 -05:00
- The pull request should have a useful title and include a link to the package and why it should be included.
2014-07-11 09:34:45 -04:00
Thank you for your suggestions!