Awesome-Mirrors/awesome-actions
1
0
Fork 0
mirror of https://github.com/sdras/awesome-actions.git synced 2024-10-01 00:55:38 -04:00
Code Issues Packages Projects Releases Wiki Activity

update the contributing.md

Browse Source
This commit is contained in:
Sarah Drasner 2019-12-07 16:02:48 -07:00
parent 1ba1cbf164
commit c4a2dea085
1 changed files with 6 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
contributing.md
View File

@ -2,27 +2,27 @@
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. 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.
If you are new to open source, I've written a [guide for how to contribute](https://css-tricks.com/how-to-contribute-to-an-open-source-project/).
> The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed. Please carefully read everything in `Adding to this list`. > The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed. Please carefully read everything in `Adding to this list`.
## Table of Contents ## Table of Contents
- [Adding to this list](#adding-to-this-list) - [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) - [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:
- Search previous suggestions before making a new one, as yours may be a duplicate. - Please submit your contribution at the end of the list of the relevant category. If you don't find a section that it belongs in, please make one.
- Please put your new addition at the end of the list of whatever section it is most relevant to. If you don't find a section that it belongs in, please make one. - Please don't use a long description. The description should not wrap to 3 lines, ideally it should fit on one.
- Search previous suggestions before making a new one, as yours may be a duplicate.
- Please don't use bold or italics unless it's somehow appropriate to the link. - Please don't use bold or italics unless it's somehow appropriate to the link.
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description. - 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. - Make an individual pull request for each suggestion.
- Use Title Casing. - Use Title Casing.
- Use the following format: `[List Name](link)` - 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. - New categories or improvements to the existing categorization are welcome.
- Please check your spelling and grammar. - Please check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace. - Make sure your text editor is set to remove trailing whitespace.
@ -31,21 +31,8 @@ Please ensure your pull request adheres to the following guidelines:
Thank you for your suggestions! 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/sdras/awesome-actions
2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.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)
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/)!
## 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, we 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-actions 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. [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.