mirror of
https://github.com/sindresorhus/awesome
synced 2024-11-24 04:53:10 +00:00
35 lines
2.2 KiB
Markdown
35 lines
2.2 KiB
Markdown
# Contribution Guidelines
|
|
|
|
## 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 list is useful before submitting. That implies it has enough content and every item has a good succinct description.
|
|
- 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.
|
|
- 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!
|
|
|
|
## Creating your own awesome list
|
|
|
|
To create your own list, check out the [instructions](create-list.md).
|
|
|
|
## 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/)!
|