Skip to content

Commit 6996cc6

Browse files
committed
Create contributing.md
1 parent ce1e2a6 commit 6996cc6

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

contributing.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contribution Guidelines
2+
3+
Please ensure your pull request adheres to the following guidelines:
4+
5+
- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
6+
- Search previous suggestions before making a new one, as yours may be a duplicate.
7+
- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
8+
- A link back to this list from yours, so users can discover more lists, would be appreciated.
9+
- Make an individual pull request for each suggestion.
10+
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
11+
- Use the following format: `[List Name](link)`
12+
- If you have a comment about the link, add it after a dash, start it with a capital letter, and end it with a full stop. Avoid starting your comment with an article like "A", "The".
13+
- Link additions should be added to the bottom of the relevant category.
14+
- New categories or improvements to the existing categorization are welcome.
15+
- Check your spelling and grammar.
16+
- Make sure your text editor is set to remove trailing whitespace.
17+
- The pull request and commit should have a useful title.
18+
19+
Link format:
20+
21+
```
22+
[Awesome resource name](resource link) - Performant REST client library by the famous John Doe.
23+
^ ^ ^
24+
dash capital letter, no article Full stop
25+
```
26+
27+
Thank you for your suggestions!

0 commit comments

Comments
 (0)