2014-09-26 03:45:26 -04:00
We appreciate and recognize [all contributors ](https://github.com/veggiemonk/awesome-docker/graphs/contributors ).
2016-04-17 02:31:36 -04:00
Please note that this project is released with a [Contributor Code of Conduct ](https://github.com/sindresorhus/awesome/blob/master/code-of-conduct.md ). By participating in this project you agree to abide by its terms.
2016-04-14 03:38:50 -04:00
2017-01-27 07:46:59 -05:00
# Table of Contents
- [Awesome Docker contribution guidelines ](#contribution-guidelines )
- [Quality Standard ](#quality-standard )
2014-09-26 03:45:26 -04:00
# Contribution Guidelines
2017-02-12 12:40:53 -05:00
#### Your commit message will be a tweet so make a beautiful commit message, keep that in mind :)
2017-01-27 07:46:59 -05:00
2017-02-12 12:40:53 -05:00
- **To add to the list:** Submit a pull request or open an issue
- **To remove from the list:** Submit a pull request or open an issue
- want to change something: Submit a pull request or open an issue
- want to try something else: Submit a pull request or open an issue
2017-01-27 07:46:59 -05:00
- don't know what to do: Submit a pull request or open an issue, let us know what's going on.
2014-09-26 03:45:26 -04:00
2017-02-12 12:40:53 -05:00
or you can
2017-02-18 03:46:39 -05:00
#### Join the chat:
2017-02-18 15:48:14 -05:00
[](https://gitter.im/veggiemonk/awesome-docker)
2017-02-18 03:46:39 -05:00
or you can
2017-02-12 12:40:53 -05:00
#### ping us on twitter:
* [veggiemonk ](https://twitter.com/veggiemonk )
2017-02-14 02:13:39 -05:00
* [idomyowntricks ](https://twitter.com/idomyowntricks )
2017-02-12 12:40:53 -05:00
* [gesellix ](https://twitter.com/gesellix )
2017-02-14 22:26:35 -05:00
* [dmitrytokarev ](https://twitter.com/dmitrytok )
2017-02-12 12:40:53 -05:00
2017-02-07 08:42:09 -05:00
`awesome-docker` is a hand-crafted list for high-quality information about docker and its resources.
It would be nice if it is related or compatible with docker in some way.
2017-02-12 12:40:53 -05:00
But if it's awesome, let's us know why and you're good to go!
2014-09-26 03:45:26 -04:00
2017-01-27 07:46:59 -05:00
- Each item should be limited to one link, no duplicates, no redirection (careful with `http` vs `https` !)
2014-09-26 03:45:26 -04:00
- The link should be the name of the package or project or website
2017-01-27 07:46:59 -05:00
- Description should be clear and concise (read it out loud to be sure)
- Description should follow the link, on the same line
2015-04-25 05:27:48 -04:00
- if you want to add more than one link, please don't do all PR on the exact same line, it usually results in conflicts and your PR cannot be automatically merged...
2014-09-26 03:45:26 -04:00
Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.
2017-01-27 07:46:59 -05:00
# Quality standard
2017-02-07 08:42:09 -05:00
Note that we can help you achieve those standards, just try your best, be brave.
2017-01-27 07:46:59 -05:00
We'll guide you to the best of our abilities.
2014-09-26 03:45:26 -04:00
2014-11-12 03:25:37 -05:00
To be on the list, it would be *nice* if entries adhere to these quality standards:
2014-09-26 03:45:26 -04:00
2017-02-12 12:40:53 -05:00
- Generally useful to the community.
- A project on github with a beautiful readme and plenty of examples is considered high quality.
- Clearly stating when an entry is relating to (Linux) containers and not Docker.
- Clearly "what is it" i.e. which category it belongs. Just try your best, we'll help you if needed.
- Clearly stating "what is it for" i.e. mention the problem it solves. Just try your best, make it clear for the next person.
- Solves a real problem (even a small one).
2017-04-20 08:14:08 -04:00
- If it is a **WIP** (work in progress, not safe for production), mention it. (Remember the time before Docker 1.0 ? ;-) )
- Always put the link to the github project instead of the website!
2016-04-14 03:38:50 -04:00
2017-02-16 09:20:14 -05:00
To be on the list, the project **must** have:
- How to setup the project
- How to use the project (examples)
2017-04-15 09:25:08 -04:00
If your PR is not merged, we will tell you why so that you may be able to improve it.
2017-02-16 09:20:14 -05:00
But usually, we are pretty relaxed people, so just come and say hi, we'll figure something out together.
2016-04-14 03:38:50 -04:00
2017-04-04 02:37:37 -04:00
# New Collaborators
If you just joined the team of maintainers for this repo, first of all: WELCOME!
2017-04-15 09:25:08 -04:00
If it is your first time maintaining an open source project, read the [best practice guides for maintainers ](https://opensource.guide/best-practices/ ).
2017-04-04 02:37:37 -04:00
Here are the few things you need to know:
* we don't push directly to master, we create a pull request. Every entry has to be reviewed.
* how to tell if a project should be on the list, read this file `CONTRIBUTING.md`
* to ask a contributor to make a change, just copy paste this message [here ](https://github.com/veggiemonk/awesome-docker/pull/289#issuecomment-285608004 ) and changes a few things like names and stuff. The main idea is to help people get to quality.
* If something seems weird, if you don't understand what a project does or the documentation is poor, don't hesitate to ask for more (see previous point).
