mirror of
https://github.com/sindresorhus/awesome.git
synced 2024-12-22 17:06:08 +00:00
31 lines
2.0 KiB
Markdown
31 lines
2.0 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.
|
|
|
|
## Adding an awesome list
|
|
|
|
Please ensure your pull request adheres to the [list guidelines](pull_request_template.md).
|
|
|
|
## 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/)!
|
|
|
|
## Updating your Pull Request
|
|
|
|
Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
|
|
|
|
[Here](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
|