40 lines
2.4 KiB
Markdown
40 lines
2.4 KiB
Markdown
|
# Contribution Guidelines
|
||
|
|
|
||
|
|
Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
- [Adding to this list](#adding-to-this-list)
|
||
|
|
- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
|
||
|
|
|
||
|
|
## Adding to this list
|
||
|
|
|
||
|
|
Please ensure your pull request adheres to the following guidelines:
|
||
|
|
|
||
|
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||
|
|
- Make sure the item is useful before submitting.
|
||
|
|
- Make an individual pull request for each suggestion.
|
||
|
|
- Use [title-casing](http://titlecapitalization.com) (AP style).
|
||
|
|
- Use the following format: `[List Name](link) - Description.`
|
||
|
|
- Link additions should be added to the bottom of the relevant category.
|
||
|
|
- 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.
|
||
|
|
- The body of your commit message should contain a link to the repository.
|
||
|
|
|
||
|
|
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](https://github.com/join)!
|
||
|
|
|
||
|
|
1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
|
||
|
|
2. Click on the `README.md` file: 
|
||
|
|
3. Now click on the edit icon. 
|
||
|
|
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/). 
|
||
|
|
5. Say why you're proposing the changes, and then click on "Propose file change". 
|
||
|
|
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
|