awesome-docker/CONTRIBUTING.md

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](https://github.com/veggiemonk/awesome-docker/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

# Table of Contents

- [Mission Statement](#mission-statement)
- [Quality Standard](#quality-standards)
- [Awesome Docker contribution guidelines](#contribution-guidelines)
- [New Collaborators](#new-collaborators)

# 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.
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 or chat), let's us know why and we will help you!

# Quality Standards

Note that we can help you achieve those standards, just try your best, 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:

- 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).
- 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!

To be on the list, the project **must** have:

- How to setup 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.

# Contribution Guidelines

## I want to share a project, what should I do?

- **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
- don't know what to do: Submit a pull request or open an issue, let us know what's going on.

### Rules for Pull Request

- Each item should be limited to one link, no duplicates, no redirection (careful with `http` vs `https`!)
- The link should be the name of the package or project or website
- Description should be clear and concise (read it out loud to be sure)
- Description should follow the link, on the same line
- 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...

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 so make a beautiful commit message, keep that in mind :)

or you can

#### Join the chat:

[![Join the chat at https://gitter.im/veggiemonk/awesome-docker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/veggiemonk/awesome-docker)

or you can

#### ping us on twitter:

* [veggiemonk](https://twitter.com/veggiemonk)
* [idomyowntricks](https://twitter.com/idomyowntricks)
* [gesellix](https://twitter.com/gesellix)
* [dmitrytokarev](https://twitter.com/dmitrytok)

# New Collaborators

If you just joined the team of maintainers for this repo, first of all: WELCOME!

If it is your first time maintaining an open source project, read the [best practice guides for maintainers](https://opensource.guide/best-practices/).

Here are the few things you need to know:
* we don't push directly to master, we create a pull request. Every entry **MUST** 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 (nicely) ask for more (see previous point).
* Say thank you to people who contribute to this project! It may not seems like much but respect and gratitude are important :D
Creating guide lines for contributing 2014-09-26 07:45:26 +00:00			`We appreciate and recognize [all contributors](https://github.com/veggiemonk/awesome-docker/graphs/contributors).`

Update link to code of conduct 2017-06-20 19:30:40 +00:00			`Please note that this project is released with a [Contributor Code of Conduct](https://github.com/veggiemonk/awesome-docker/blob/master/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.`
improved contributind.md 2016-04-14 07:38:50 +00:00
Update CONTRIBUTING.md 2017-01-27 12:46:59 +00:00			`# Table of Contents`

Update CONTRIBUTING.md 2017-07-11 07:18:24 +00:00			`- [Mission Statement](#mission-statement)`
			`- [Quality Standard](#quality-standards)`
Update CONTRIBUTING.md reordering sections 2017-07-11 08:55:52 +00:00			`- [Awesome Docker contribution guidelines](#contribution-guidelines)`
Update CONTRIBUTING.md 2017-07-11 07:18:24 +00:00			`- [New Collaborators](#new-collaborators)`
Update CONTRIBUTING.md 2017-01-27 12:46:59 +00:00
Update CONTRIBUTING.md 2017-07-11 07:18:24 +00:00			`# 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.
Update CONTRIBUTING.md Refine contribution guidelines 2017-07-11 09:03:26 +00:00			`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 or chat), let's us know why and we will help you!`
Creating guide lines for contributing 2014-09-26 07:45:26 +00:00
Update CONTRIBUTING.md 2017-07-11 07:18:24 +00:00			`# Quality Standards`
Update CONTRIBUTING.md 2017-01-27 12:46:59 +00:00
update contribution guidelines 2017-02-07 13:42:09 +00:00			`Note that we can help you achieve those standards, just try your best, be brave.`
Update CONTRIBUTING.md 2017-01-27 12:46:59 +00:00			`We'll guide you to the best of our abilities.`
Creating guide lines for contributing 2014-09-26 07:45:26 +00:00
simplying rules 2014-11-12 08:25:37 +00:00			`To be on the list, it would be nice if entries adhere to these quality standards:`
Creating guide lines for contributing 2014-09-26 07:45:26 +00:00
Update CONTRIBUTING.md added the twitter alias of the maintainers 2017-02-12 17:40:53 +00: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).`
Update CONTRIBUTING.md 2017-04-20 12:14:08 +00: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!`
improved contributind.md 2016-04-14 07:38:50 +00:00
Update CONTRIBUTING.md 2017-02-16 14:20:14 +00:00			`To be on the list, the project must have:`

			`- How to setup the project`
			`- How to use the project (examples)`


Added link for new maintainers 2017-04-15 13:25:08 +00:00			`If your PR is not merged, we will tell you why so that you may be able to improve it.`
Update CONTRIBUTING.md 2017-02-16 14:20:14 +00:00			`But usually, we are pretty relaxed people, so just come and say hi, we'll figure something out together.`
improved contributind.md 2016-04-14 07:38:50 +00:00
Update CONTRIBUTING.md reordering sections 2017-07-11 08:55:52 +00:00			`# Contribution Guidelines`

			`## I want to share a project, what should I do?`

			`- 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`
			`- don't know what to do: Submit a pull request or open an issue, let us know what's going on.`

Update CONTRIBUTING.md Refine contribution guidelines 2017-07-11 09:03:26 +00:00			`### Rules for Pull Request`

			- Each item should be limited to one link, no duplicates, no redirection (careful with `http` vs `https`!)
			`- The link should be the name of the package or project or website`
			`- Description should be clear and concise (read it out loud to be sure)`
			`- Description should follow the link, on the same line`
			`- 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...`

			`Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.`


Update CONTRIBUTING.md reordering sections 2017-07-11 08:55:52 +00:00			`#### Your commit message will be a tweet so make a beautiful commit message, keep that in mind :)`

			`or you can`

			`#### Join the chat:`

			`[![Join the chat at https://gitter.im/veggiemonk/awesome-docker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/veggiemonk/awesome-docker)`

			`or you can`

			`#### ping us on twitter:`

			`* [veggiemonk](https://twitter.com/veggiemonk)`
			`* [idomyowntricks](https://twitter.com/idomyowntricks)`
			`* [gesellix](https://twitter.com/gesellix)`
			`* [dmitrytokarev](https://twitter.com/dmitrytok)`

add text for new collaborators, maintainers 2017-04-04 06:37:37 +00:00			`# New Collaborators`

			`If you just joined the team of maintainers for this repo, first of all: WELCOME!`

Added link for new maintainers 2017-04-15 13:25:08 +00:00			`If it is your first time maintaining an open source project, read the [best practice guides for maintainers](https://opensource.guide/best-practices/).`

add text for new collaborators, maintainers 2017-04-04 06:37:37 +00:00			`Here are the few things you need to know:`
Update CONTRIBUTING.md Refine contribution guidelines 2017-07-11 09:03:26 +00:00			`* we don't push directly to master, we create a pull request. Every entry MUST 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 (nicely) ask for more (see previous point).`
			`* Say thank you to people who contribute to this project! It may not seems like much but respect and gratitude are important :D`