awesome/contributing.md

33 lines
2.0 KiB
Markdown
Raw Normal View History

2015-05-21 10:23:54 +00:00
# Contribution Guidelines
Please ensure your pull request adheres to the following guidelines:
2015-07-09 13:23:08 +00:00
- Read [the awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
2015-07-25 19:32:45 +00:00
- Wait at least a couple of weeks after creating a list before submitting to give it a chance to mature.
2015-05-21 10:23:54 +00:00
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Make sure your list is useful before submitting. That implies it having enough content and every item a good succinct description.
- A link back to this list from yours, so users can discover more lists, would be appreciated.
- Make an individual pull request for each suggestion.
- Titles should be [capitalized](http://grammar.yourdictionary.com/capitalization/rules-for-capitalization-in-titles.html).
- Use the following format: `[List Name](link)`
- Link additions should be added to the bottom of the relevant category.
2015-05-21 10:23:54 +00:00
- New categories or improvements to the existing categorization are welcome.
- 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.
Thank you for your suggestions!
## Adding something to an Awesome list
If you have something awesome to contribute to an awesome list, this is how you do it.
You'll need a GitHub account!
1. Access the awesome list's GitHub page. For example: `https://github.com/sindresorhus/awesome/`
2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](http://i.imgur.com/mLEnC9m.png)
3. Now click on the edit icon ![Step 3 - Click on Edit](http://i.imgur.com/Z7P2gOP.png)
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/) ![Step 4 - Edit the file](http://i.imgur.com/YfdyOOI.png)
5. Say why you're proposing the changes, and then click on "Propose file change" ![Step 5 - Propose Changes](http://i.imgur.com/InVqEP4.png)
6. Submit the pull request!