ch0ic3/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2025-01-31 12:07:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #390 from RichardLitt/feature/updating-pr

Browse Source 
Add section on how to update a pull request
This commit is contained in:
Sindre Sorhus 2015-11-01 22:54:33 +07:00
commit 562142890a
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
contributing.md
View File

@ -1,5 +1,11 @@
# Contribution Guidelines # Contribution Guidelines
## Table of Contents
- [Adding to this list](#adding-to-this-list)
- [Creating your own awesome list](#creating-your-own-awesome-list)
- [Adding something to an Awesome list](#adding-something-to-an-awesome-list)
- [Updating your Pull Request](#updating-your-pull-request)
## Adding to this list ## Adding to this list
Please ensure your pull request adheres to the following guidelines: Please ensure your pull request adheres to the following guidelines:
@ -21,7 +27,7 @@ Thank you for your suggestions!
To create your own list, check out the [instructions](create-list.md). To create your own list, check out the [instructions](create-list.md).
## Adding something to an Awesome list ## Adding something to an awesome list
If you have something awesome to contribute to an awesome list, this is how you do it. If you have something awesome to contribute to an awesome list, this is how you do it.
@ -33,3 +39,9 @@ You'll need a [GitHub account](https://github.com/join)!
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](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.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](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png) 5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)! 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/docs/blob/master/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.