Awesome-Mirrors/awesome-docker
1
0
Fork 0
mirror of https://github.com/veggiemonk/awesome-docker.git synced 2024-07-01 17:11:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved contributind.md

Browse Source
This commit is contained in:
Julien Bisconti 2016-04-14 09:38:50 +02:00
parent 69d054ff9a
commit d7e8c5e349
1 changed files with 54 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
CONTRIBUTING.md
View File

@ -1,5 +1,7 @@
We appreciate and recognize [all contributors](https://github.com/veggiemonk/awesome-docker/graphs/contributors).
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.
# Contribution Guidelines
- **To add to the list:** Submit a pull request
@ -8,7 +10,7 @@ We appreciate and recognize [all contributors](https://github.com/veggiemonk/awe
- want to try something else: Submit a pull request
- don't know what to do: Submit a pull request
`awesome-docker` is a hand-crafted list for high-quality information about docker and its resources. I don't feel it should be constraint to docker only ressources, so feel free to add other resources about container or deployement in general. It would be nice if it is related or compatible with docker in some way. But if it's awesome, OK!
`awesome-docker` is a hand-crafted list for high-quality information about docker and its resources. I don't feel it should be constraint to docker only ressources, so feel free to add other resources about container or deployment in general. It would be nice if it is related or compatible with docker in some way. But if it's awesome, OK!
- Each item should be limited to one link
- The link should be the name of the package or project or website
@ -29,3 +31,54 @@ To be on the list, it would be *nice* if entries adhere to these quality standar
- Clearly stating "what is it for": mention the problem it solves. Just try your best, make it clear for the next person.
- Solves a real problem (even a small one)
- if it is a **WIP** (work in progress, not safe for production), mention it. (Remember the time before Docker 1.0 ? ;-) )
# Awesome Related 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
Please ensure your pull request adheres to the following guidelines:
- Search previous suggestions before making a new one, as yours may be a duplicate.
- 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.
- Use [title-casing](http://titlecapitalization.com) (AP style).
- 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.
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
- The pull request and commit should have a useful title.
- The body of your commit message should contain a link to the repository.
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
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: ![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
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.