mirror of
https://github.com/veggiemonk/awesome-docker.git
synced 2025-11-24 01:14:28 +01:00
9
.github/CONTRIBUTING.md
vendored
9
.github/CONTRIBUTING.md
vendored
@@ -17,7 +17,7 @@ Please note that this project is released with a [Contributor Code of Conduct](h
|
||||
|
||||
# Mission Statement
|
||||
|
||||
`awesome-docker` is a hand-crafted list for high-quality information about Docker and its resources. It should be related or compatible with Docker. If it's just an image built on top of Docker, the project possibly belongs to other [awesome lists](https://github.com/sindresorhus/awesome). You can check the [awesome-selfhosted list](https://github.com/Kickball/awesome-selfhosted) or the [awesome-sysadmin list](https://github.com/n1trux/awesome-sysadmin) as well.
|
||||
`awesome-docker` is a hand-crafted list for high-quality information about Docker and its resources. It should be related or compatible with Docker or containers. If it's just an image built on top of Docker, the project possibly belongs to other [awesome lists](https://github.com/sindresorhus/awesome). You can check the [awesome-selfhosted list](https://github.com/Kickball/awesome-selfhosted) or the [awesome-sysadmin list](https://github.com/n1trux/awesome-sysadmin) as well.
|
||||
If it's a **tutorial or a blog post**, they get outdated really quickly so we don't really put them on the list but if it is on a very advanced and/or specific topic, we will consider it!
|
||||
If something is awesome, share it (pull request or [issue](https://github.com/veggiemonk/awesome-docker/issues/new) or [chat](https://gitter.im/veggiemonk/awesome-docker)), let us know why and we will help you!
|
||||
|
||||
@@ -26,8 +26,9 @@ If something is awesome, share it (pull request or [issue](https://github.com/ve
|
||||
Note that we can help you achieve those standards, just try your best and be brave.
|
||||
We'll guide you to the best of our abilities.
|
||||
|
||||
To be on the list, it would be *nice* if entries adhere to these quality standards:
|
||||
To be on the list, it would be **nice** if entries adhere to these quality standards:
|
||||
|
||||
- It should take less than 20 sec to find what is the project, how to install it and how to use it.
|
||||
- Generally useful to the community.
|
||||
- A project on GitHub with a well documented `README.md` file and plenty of examples is considered high quality.
|
||||
- Clearly stating if an entry is related to (Linux) containers and not to Docker. There is an [awesome list](https://github.com/Friz-zy/awesome-linux-containers) for that.
|
||||
@@ -38,10 +39,9 @@ To be on the list, it would be *nice* if entries adhere to these quality standar
|
||||
|
||||
To be on the list, the project **must** have:
|
||||
|
||||
- How to setup the project
|
||||
- How to setup/install the project
|
||||
- How to use the project (examples)
|
||||
|
||||
|
||||
If your PR is not merged, we will tell you why so that you may be able to improve it.
|
||||
But usually, we are pretty relaxed people, so just come and say hi, we'll figure something out together.
|
||||
|
||||
@@ -78,7 +78,6 @@ or you can
|
||||
|
||||
Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.
|
||||
|
||||
|
||||
#### Your commit message will be a [tweet](https://twitter.com/awesome_docker) so write a [good commit message](https://chris.beams.io/posts/git-commit/), keep that in mind :)
|
||||
|
||||
# New Collaborators
|
||||
|
||||
Reference in New Issue
Block a user