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 contributing- remove broken link and clarify requests

Browse Source
This commit is contained in:
sdras 2018-10-21 14:12:41 -06:00
parent 2a84d65447
commit 083b383caa
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
contributing.md
View File

@ -2,7 +2,7 @@
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.
# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. 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
@ -16,30 +16,28 @@ Please note that this project is released with a [Contributor Code of Conduct](c
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. - Search previous suggestions before making a new one, as yours may be a duplicate.
- Please put your new addition at the end of the list.
- 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](http://titlecapitalization.com) (AP style). - 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. - 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.
- 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.
- The pull request and commit should have a useful title. - The pull request and commit should have a useful title.
- The body of your commit message should contain a link to the repository. - The body of your commit message should contain a link to the repository.
Thank you for your suggestions! 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 ## 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.
You'll need a [GitHub account](https://github.com/join)! 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 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) 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) 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)