mirror of
https://github.com/veggiemonk/awesome-docker.git
synced 2024-10-01 01:36:03 -04:00
84 lines
4.2 KiB
Markdown
84 lines
4.2 KiB
Markdown
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
|
|
|
|
- [Awesome Docker contribution guidelines](#contribution-guidelines)
|
|
- [Quality Standard](#quality-standard)
|
|
|
|
# Contribution Guidelines
|
|
|
|
#### Your commit message will be a tweet so make a beautiful commit message, keep that in mind :)
|
|
|
|
- **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.
|
|
|
|
or you can
|
|
|
|
#### Join the chat:
|
|
|
|
[](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)
|
|
|
|
`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.
|
|
But if it's awesome, let's us know why and you're good to go!
|
|
|
|
- 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.
|
|
|
|
|
|
# Quality standard
|
|
|
|
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.
|
|
|
|
# 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 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).
|