python / python/devguide

Improvements to Lifecycle of a pull request

未關閉
#1,358 4 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 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.d record. It's just very briefly mentioned in patchcheck.
  • "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.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 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

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。