awesome-docker/.github/PULL_REQUEST_TEMPLATE.md

38 lines
1.9 KiB
Markdown

<!-- Congrats on creating an Awesome Docker entry! 🎉 -->
<!-- Please fill in the below placeholders -->
**[Insert the URL to be listed]**
**[Explain what the project is about and why it should be listed]**
# By submitting this pull request I confirm I've read and complied with the below requirements.
**Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.**
- I have read and understood the [contribution guidelines](https://github.com/veggiemonk/awesome-docker/blob/master/.github/CONTRIBUTING.md)
- The project submitted conforms to the quality standards outlined in the [contribution guidelines](https://github.com/veggiemonk/awesome-docker/blob/master/.github/CONTRIBUTING.md)
- Go to the [contribution guidelines](https://github.com/veggiemonk/awesome-docker/blob/master/.github/CONTRIBUTING.md) and read it again.
**RULES (because you probably didn't read the guidelines):**
Links will be tested with [awesome_bot](https://github.com/dkhamsing/awesome_bot). Please make sure your URL to be listed is unique (do some search queries), otherwise put a link at the end of `README.md` file.
- FORMAT
- Use the following format: `[Name](Link) - Description.`
- `[Name]` should be the title of the project
- `(Link)` should be pointing to a GitHub repository, not to a website
- `Description.` should end with a full stop/period
- For GitHub repositories, add the name of the author with a link to its GitHub account after the description, like `By [@author](GitHub account)`
- ORDER: The entries are in lexical order (English letter order)
- LABEL (Optional): Add one of the following icons next to the project name like ```[Name](Link) :icon: - Description.```
- :heavy_dollar_sign: indicates if one needs a paying subscription to use the project.
- :construction: indicates that the project is a work in progress/beta release.
- :skull: indicates that the project is obsolete, but still worth mentioning it.