ch0ic3/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2024-12-22 17:06:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add PR template mention to Contributing guideline

Browse Source 
The Pull Request template
https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md
is not explicitly mentioned in the Contribution Guidelines page, and it
includes additional requirements not seen by the time someone is
creating a Pull Request. This fixes that.

Changes to be committed:
	modified:   contributing.md
This commit is contained in:
Austin Soplata 2018-05-14 16:21:10 -04:00
parent ea8d171d40
commit 6ccd5d54e2
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
contributing.md
View File

@ -44,10 +44,10 @@ You'll need a [GitHub account](https://github.com/join)!
3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png) 3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.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) 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. Make sure your [pull request](https://help.github.com/articles/using-pull-requests/) follows the [awesome-* list pull request template](https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md), then submit the pull request!
## Updating your Pull Request ## 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. 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 or the [PR template](https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md).
[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. [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.