Skip to content

Commit

Permalink
Add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yenchenlin committed Aug 27, 2015
1 parent 3108566 commit 0e73d2a
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions contributing.md
@@ -0,0 +1,18 @@
# 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.
- 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.
- New categories, or improvements to the existing categorization are welcome.
- Keep descriptions short and simple, but descriptive.
- 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.
- 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.

Thank you for your suggestions!

0 comments on commit 0e73d2a

Please sign in to comment.