Skip to content

Commit e866d81

Browse files
authoredNov 29, 2018
Create CONTRIBUTING.md
1 parent e0aef73 commit e866d81

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed
 

‎CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contribution Guidelines
2+
3+
- Use a meaningful name to your commit or I'll close it instantly
4+
5+
Ensure your pull request adheres to the following guidelines:
6+
7+
- Search previous suggestions before making a new one, as yours may be a duplicate.
8+
- Suggested packages should be tested and documented.
9+
- The pull request should have a meaningful title and include a link to the package / resource and why it's awesome.
10+
- Make an individual pull request for each suggestion.
11+
- Use the following format: `[resource](link) - Description by [Author](link to author)`
12+
- Use [title-casing](http://titlecapitalization.com) (AP style).
13+
- Additions should be added to the bottom of the relevant category.
14+
- New categories, or improvements to the existing categorization are welcome.
15+
- Keep descriptions short and simple, but descriptive.
16+
- Don't mention `Quantified Self` in the description as it's implied.
17+
- Start the description with a capital.
18+
- Check your spelling and grammar.
19+
- Make sure your text editor is set to remove trailing whitespace.
20+
21+
Thank you for your suggestions!

0 commit comments

Comments
 (0)