lib/awesome-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(github): align contributor docs and CI with Go workflow

Browse Source
This commit is contained in:
Julien Bisconti
2026-02-28 00:06:37 +01:00
parent 0f00303939
commit dc01ff137e
9 changed files with 120 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -1,48 +1,28 @@
<!-- Congrats on creating an Awesome Docker entry! 🎉 -->
# Summary
<!-- **Remember that entries are ordered alphabetically** -->
Describe what changed and why.
# TLDR
* all entries sorted alphabetically (from A to Z),
* If paying service add :heavy_dollar_sign:
* If WIP add :construction:
* clear and short description of the project
* project MUST have: How to setup/install
* project MUST have: How to use (examples)
* we can help you get there :)
## Scope
## Quality Standards
- [ ] README entries/content
- [ ] Go CLI/tooling
- [ ] GitHub workflows or `.github` docs
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.
## If This PR Adds/Edits README Entries
To be on the list, it would be **nice** if entries adhere to these quality standards:
- Category/section touched:
- New or updated project links:
- 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.
- Clearly stating "what is it" i.e. which category it belongs to.
- Clearly stating "what is it for" i.e. mention a real problem it solves (even a small one). Make it clear for the next person.
- If it is a **WIP** (work in progress, not safe for production), please mention it. (Remember the time before Docker 1.0 ? ;-) )
- Always put the link to the GitHub project instead of the website!
## Validation
To be on the list, the project **must** have:
- [ ] `make lint`
- [ ] `make test` (if Go code changed)
- [ ] `./awesome-docker check` (if `GITHUB_TOKEN` available)
- 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.
# 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
- Entries are listed alphabetically, please respect the order
- 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.
## Contributor Checklist
- [ ] Entries are alphabetically ordered in their section
- [ ] Links point to project repositories (no duplicates or redirects)
- [ ] Descriptions are concise and specific
- [ ] Archived/deprecated projects were removed instead of tagged
- [ ] Used `:construction:` and `:heavy_dollar_sign:` only when applicable