MY PERFORMANCE蝴蝶刀设计解析与实战测评：从基础到进阶
2026/9/3 14:23:36
如何向awesome-python提交PR：完整贡献指南与10条自动拒收规则避雷清单
【免费下载链接】awesome-pythonThe definitive list that answers "I want to do X in Python, which tool should I use?"项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-python
awesome-python 是一份有主见的 Python 工具精选清单，回答"我想用 Python 做 X，该选哪个工具"。本指南教你如何向 awesome-python 提交 PR：从克隆仓库、写一条合格的 Entry，到避开全部 10 条自动拒收规则，帮你一次通过维护者审核。
先搞清楚：awesome-python 是精选短名单，不是工具目录
提交前最重要的一句话：awesome-python is a shortlist, not a catalog（它是精选短名单，不是目录）。
- 每个"用例（Use Case）"最多只列3 个首选 + 2 个挑战者，硬性上限 5 条
- 大多数拒绝意味着"该用例名额已满"，而不是"你的项目很糟糕"
- 准入主要参考PyPI 下载量，而不是 GitHub stars
- 想要穷举式目录？请去对应的 awesome-* 子清单（如 awesome-python-testing）
完整决策记录见 docs/adr/0001-shortlist-not-catalog.md，术语定义见 CONTEXT.md。
提交 PR 前的一键准备步骤
- 克隆仓库（仓库是只读的，请勿直接修改线上内容）：
git clone https://gitcode.com/GitHub_Trending/aw/awesome-python cd awesome-python- 通读 CONTRIBUTING.md——这是审核的唯一规则来源
- 搜索历史 PR 和 Issue，确认你的项目没有被列过、也没有被拒过
- 在 README.md 中找到目标用例（Section 或 Subcategory）位置
⚠️ 注意：新增 Section 或 Subcategory 是维护者专属权限，你的 PR 无法创建自己需要的分类。
5 项质量要求：全部满足才可能入选
| 要求 | 说明 |
|---|---|
| 服务于 Python 开发者 | 语言无关——Rust 写的 uv、ty 也在列；关键是"Python 开发者在 Python 工作中用它" |
| 活跃 | 最近12 个月内有提交 |
| 稳定 | 生产可用，非 alpha/beta/实验性质 |
| 有文档 | README 清晰，有示例和用例说明 |
| 有沉淀 | 仓库创建至少1 个月 |
Entry 格式与命名规范速查
- 命名：用PyPI 包名作为显示名，方便读者直接
pip install；不在 PyPI 的项目用仓库名 - 链接：优先使用 GitHub 仓库 URL
- 标准条目：
- [pypi-name](https://github.com/owner/repo) - Description ending with period.（描述以句号结尾） - 标准库条目：加
(Python standard library)前缀，且仅当标准库本身就是该用例的首选 - 排序：用例内按 PyPI 月下载量从高到低；无下载信号的项目排在末位
完整格式参考（含 Fork 条目、带 awesome-* 子清单的条目、子分类写法）都在 CONTRIBUTING.md 的Entry Format Reference一节。
🚫 10 条自动拒收规则避雷清单
命中任何一条，PR 会直接被 close。提交前逐条自查：
| # | 自动拒收原因 | 避雷要点 |
|---|---|---|
| 1 | 一个 PR 提交多个项目 | 一个 PR 只加一个项目，一次一个 commit |
| 2 | 用例已满但未做 Displacement 论证 | 满额时须点名你要替换的条目，并论证你的项目做得更好（一进一出） |
| 3 | PR 新建 Section/Subcategory 并填充 | 结构调整仅限维护者，别碰结构 |
| 4 | 同组织/作者的关联项目协同自荐 | 多个关联项目分多个 PR 提交同样会被识别，放弃 |
| 5 | 与现有条目或近期已关闭的 PR 重复 | 提交前务必搜索历史 PR/Issue |
| 6 | PR 描述为空或占位符 | 认真写清：为什么该项目是"obvious choice" |
| 7 | 放错分类 | 精确定位用例，不确定就先问维护者 |
| 8 | 项目已归档或 12 个月以上无提交 | 自查最后 commit 时间 |
| 9 | 无文档或用例不清晰 | README 必须能让人看懂它解决什么问题 |
| 10 | 仓库创建不满 1 个月 | 新项目先养一养，成熟再提交 |
PR 会经历哪 5 道自动 + 人工检查
- 格式检查：条目格式是否正确
- 分类检查：是否放在合适的用例
- 重复检查：是否已列出或曾被拒
- 活跃度检查：项目近期是否有活动
- 准入检查：是否满足上文准入规则（满额时含 Displacement 论证）
维护者的编辑判断是最终决定，且以PyPI 下载量为主要证据信号——所以 PR 描述里附上下载量、采用趋势等证据会大大加分。
给新手的 3 条实操建议 💡
- 先读后写：花 10 分钟通读 CONTRIBUTING.md 和 CONTEXT.md，能避开 80% 的拒收原因
- PR 描述写证据：PyPI 下载量、社区采用情况、与现有条目的对比，比"我的项目很棒"有效得多
- 保持社区礼仪：遵循 CODE_OF_CONDUCT.md，被拒后礼貌沟通，不要重复提交同样的条目
一句话总结：awesome-python 的门槛不在代码量，而在"克制"——你的项目必须是那个用例下经验丰富的 Python 开发者脱口而出的答案。做到这一点，避开 10 条红线，你的 PR 就有机会成为官方精选。
【免费下载链接】awesome-pythonThe definitive list that answers "I want to do X in Python, which tool should I use?"项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-python
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考