Add a section for etiquette when creating PRs, when multiple people wants to create the PR for the same issue
還沒有人認領這個 Issue。
- 主要語言
- Python
- 星號
- 2.1k
- 分支
- 1k
- 平均合併
- 2 天 12 小時
- 30 天內合併 PR
- 12
描述
Describe the enhancement or feature you'd like
Sometimes more than one people want to create PR for the same issue/ticket. How do we handle this situation?
From my own experience since back in the days of the bpo/roundup, there seems to be a preference that when a patch already exists, we don't try to create a new patch but work to improve the existing patch.
I've seen core devs telling contributors to "let this person finish the patch". I think we should document this preference clearly so that new contributors are aware.
I believe that this is still a good common practise with GitHub PRs, to give courtesy to whoever claimed the ticket first, giving them time and opportunity to contribute and create a PR. For example, if someone opened an issue and expressed that they want to create the PR, then others should let them create the PR instead of writing their on PR in the meantime.
In this situations, sometimes, as triagers and core devs, we may need to remind other contributors gently, that "hey this ticket is already claimed by someone else, don't go and write your own PR."
However, in order to be fair and avoid people claiming tickets and not finishing it, (and therefore preventing the issue to be completed/preventing others from also contributing), we should specify a reasonable timeline for claiming/creating the PR.
Some suggestions (gathered from Discord):
- Document that, if someone else has claimed the PR, don't write your PR yet. Instead help them with it/answer questions/clarify the issue
- Ask for/provide the timeline for completing a PR.
- Triagers/core devs can say "can you write the PR within X weeks?" (2 weeks as default, maybe depends on the complexity of the ticket?)
- Person who claimed the PR can say, "I plan to create the PR within X weeks." (or other timeframe that works for them)
- After the initial "issue claim" timeline has passed, triager/core dev should check in on the progress, and ask if anything blocks them, and work towards helping/supporting the contributor in the PR creation.
- If after the specified time, they still have not started on the PR, at that time someone else can claim the ticket and create the PR.
- Emphasize that draft PRs are welcomed
- Emphasize that these are plans, which are allowed to change, and not firm commitment
- Emphasize that it is ok if they are no longer able to create a PR, and in fact preferred if they tell us, to give opportunities to others to contribute.
Additional context
This was discussed internally among a few triagers and core devs in the #triage Core Devs Discord channel.
I'm opening an issue so that we can discuss it further and potentially add such guidelines to the devguide/the new contributing guide.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
檢視現有的 devguide 和提議的新 contributing guide,找出適合說明 contributor 行為規範的位置。為重疊的 claim、時間安排、Draft PR 以及釋放 claim 定義指引,然後在記錄之前與 triager 和核心開發者確認措辭與政策。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- github
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100