From cccfa183a9a224e230b8cd1352ed56b033a0b6f3 Mon Sep 17 00:00:00 2001 From: Vinta Chen Date: Sun, 16 Aug 2026 16:11:00 +0800 Subject: [PATCH] docs: rewrite PR template to match shortlist rules The old template used a stars-based tier system (Industry Standard / Rising Star / Hidden Gem) that contradicted the current CONTRIBUTING.md, which judges entries by obvious-choice/challenger tiers, favors PyPI downloads over stars, and requires Displacement when a use case is at its cap. The new template reflects those rules and adds a checklist item pointing contributors to CONTRIBUTING.md. Co-Authored-By: Claude --- .github/PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 05c3b804..865e26ad 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,24 +1,26 @@ ## Project -[Project Name](url) +[project-name](url) ## Checklist +- [ ] I read [CONTRIBUTING.md](https://github.com/vinta/awesome-python/blob/master/CONTRIBUTING.md) - awesome-python is a shortlist, not a catalog - [ ] One project per PR - [ ] PR title format: `Add project-name` -- [ ] Entry format: `- [project-name](url) - Description ending with period.` -- [ ] Description is concise and short +- [ ] Entry format: `- [pypi-name](https://github.com/owner/repo) - Description ending with period.` +- [ ] Display name is the PyPI package name +- [ ] Placed in an existing use case (new sections and subcategories are maintainer-only) +- [ ] Meets all Quality Requirements: active, stable, documented, at least 1 month old -## Why This Project Is Awesome +## Which Tier -Which criterion does it meet? (pick one) +Pick one: -- [ ] **Industry Standard** - The go-to tool for a specific use case -- [ ] **Rising Star** - 5000+ stars in < 2 years, significant adoption -- [ ] **Hidden Gem** - Exceptional quality, solves niche problems elegantly +- [ ] **Obvious choice** - a tool an experienced Python developer would name unprompted for this use case +- [ ] **Challenger** - not yet the obvious choice, but a credible successor to one. Give adoption-trajectory evidence, not popularity alone. Explain: -## How It Differs +## Displacement -If similar entries exist, what makes this one unique? +If the use case is at its cap, name the entry your project replaces and argue that yours does that entry's job better. One in, one out.