Improve the "Making Good PRs" section
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
首先在开发者指南中找到“Making Good PRs”部分，并查看其周围的文档层级。确定该部分应如何说明准确、简洁的 pull request 标题和描述，以及它是否应位于更高层级。完成的标准是，指南及其位置清楚地体现 issue 建议的改进。
由索引模型根据 Issue 内容生成。
描述
I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.
Suggested edits:
- Enforce a strict title format
- Promote writing accurate and concise PR titles/descriptions
Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?
- 主要语言
- Python
- 星标
- 2.1k
- 派生
- 1k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 12
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
python/devguide 的其他 Issue
-
type-feature
难度 2/5 1-3 小时 新手友好度 68/100
-
type-feature
难度 2/5 1-3 小时 新手友好度 68/100
-
topic-building python type-feature
难度 2/5 1-3 小时 新手友好度 65/100
-
needs: decision topic-test type-bug
难度 2/5 1-3 小时 新手友好度 78/100
-
topic-dev process type-feature
难度 2/5 1-3 小时 新手友好度 62/100
相似的 Issue
-
link-check link-check:sphinx-theme
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
难度 2/5 1-3 小时 新手友好度 88/100
OpenHands/extensions#626 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
CSCfi/sd-search-api#39 ·
-
难度 1/5 1 小时以内 新手友好度 90/100