diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 18c8df5..ff9c797 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -11,7 +11,6 @@ Please read and follow the [Code of Conduct](./CODE_OF_CONDUCT.md). - New high-quality projects that are **for Docker** (see the test below) - Fixes to descriptions, ordering, or categorization - Removal of broken, archived, deprecated, or duplicate entries -- Improvements to the Go CLI and GitHub workflows ## The "for Docker" Test (read this before submitting) @@ -42,9 +41,8 @@ software ever written. Before opening a PR, apply this test: ### One-sentence sanity check -Write the sentence: *"This project exists to ____."* If the blank doesn't -contain **Docker, container, image, registry, Dockerfile, Compose, Swarm, -BuildKit, or OCI** — it probably doesn't belong here. +Write the sentence: *"This project exists to ____."* +If the blank doesn't contain **Docker, container, image, registry, Dockerfile, Compose, Swarm, BuildKit, or OCI** — it probably doesn't belong here. ## README Entry Rules @@ -57,7 +55,7 @@ BuildKit, or OCI** — it probably doesn't belong here. could be any monitoring tool, and a reviewer can't tell whether the project passes the test above. - Use `:yen:` for paid/commercial services. -- Use `:ice_cube:` for stale projects (2+ years inactive). +- The project has been active in the last 2 years. - Do not use `:skull:`; archived/deprecated projects should be removed. - Avoid duplicate links and redirect variants. @@ -84,7 +82,6 @@ make test - Explain what changed and why. - If adding entries, include the target category. - If removing entries, explain why (archived, broken, duplicate, etc.). -- Fill in the PR template checklist. ## Maintainer Notes diff --git a/.github/ISSUE_TEMPLATE/add-a-project.md b/.github/ISSUE_TEMPLATE/add-a-project.md index 1cd073f..e91972e 100644 --- a/.github/ISSUE_TEMPLATE/add-a-project.md +++ b/.github/ISSUE_TEMPLATE/add-a-project.md @@ -1,21 +1,20 @@ --- name: Add a project -about: Add a new project to the list -title: "add: [PROJECT_NAME] in [SECTION_NAME]" +about: Suggest a project for the list +title: "add: [PROJECT] in [SECTION]" labels: pending-evaluation -assignees: '' - --- +# IF THE PROJECT JUST RUNS IN DOCKER, AUTOMATICALLY DENIED -Category: -Repository link: -Description (one sentence): -Author: -Why this should be in the list: -Notes (`:yen:` if relevant): +- [ ] I HAVE READ .github/CONTRIBUTING.md -Or directly write it: +Write the sentence: *"This project exists to ____."* + +If the blank doesn't contain **Docker, container, image, registry, Dockerfile, Compose, Swarm, BuildKit, or OCI**, it probably doesn't belong here. ```markdown [REPO](https://github.com/AUTHOR/REPO) - DESCRIPTION. ``` + + +Note: the project will be added faster if you create a PR (recommended!). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bd5a7c0..b09b554 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,28 +1,11 @@ -# Summary -Describe what changed and why. +# IF THE PROJECT JUST RUNS IN DOCKER, AUTOMATICALLY DENIED -## Scope +- [ ] I HAVE READ .github/CONTRIBUTING.md -- [ ] README entries/content -- [ ] Go CLI/tooling -- [ ] GitHub workflows or `.github` docs +Write the sentence: *"This project exists to ____."* -## If This PR Adds/Edits README Entries +If the blank doesn't contain **Docker, container, image, registry, Dockerfile, Compose, Swarm, BuildKit, or OCI**, it probably doesn't belong here. -- Category/section touched: -- New or updated project links: +What changed and why: -## Validation - -- [ ] `make lint` -- [ ] `make test` (if Go code changed) -- [ ] `./awesome-docker check` (if `GITHUB_TOKEN` available) - -## 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 `:yen:` only when applicable