Improvements to Lifecycle of a pull request
未关闭
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 2.1k
- 派生
- 1k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 12
描述
I write this issue as a feedback from Euro Python 2024 sprint to denote troubles I encountered as I contributed to cpython.
Describe the enhancement or feature you'd like
Missing content in "Lifecycle of a pull request" https://devguide.python.org/getting-started/pull-request-lifecycle/
- "Quick guide" is missing a step to create
NEWS.drecord. It's just very briefly mentioned inpatchcheck. - "Step-by-step guide" doesn't denote a branch naming convention. I was told to use
gh-<number>-<name>. - "Making good commits" doesn't mention
gh-<number>should be included in the commit message. - "Step-by-step guide" doesn't mention
gh-<number>should be included in the PR title.
Describe alternatives you've considered
None.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 Python developer’s guide 中链接的“Lifecycle of a pull request”页面开始,查看其中的 Quick guide、Step-by-step guide 和 Making good commits 部分。更新文档,涵盖 NEWS.d record 以及 gh- 的命名和消息约定;当所有四项要求的 workflow 详细信息都已明确说明时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100