[Feature Request] Allow Sub-PRs (one branch with commits grouped into Sub-PRs) instead of one-branch-per-Stacked-PR
- 主要語言
- Go
- 星號
- 1.5k
- 分支
- 70
- 平均合併
- 1 天 8 小時
- 30 天內合併 PR
- 7
描述
# The problem
Based on [my experience making a stack of 12 PRs to an open source repo ](https://github.com/orgs/community/discussions/201439#discussioncomment-17990845 (see post here)), I have the following feature request.
It seems to me that a "PR Stack" has the primary goal:
- make big sets of changes easier to review by breaking them up
But it has the primary drawbacks:
- requires maintaining N branches locally, writing N pull request descriptions, creating N JIRAs/issue tickets (if your org requires a 1:1 mapping there, as many do), etc. which is a ton more paperwork
- increases the load on CI by up to O(N) where N is the number of stacked PRs (and same effect on QA if your org requires QA for each PR)
- requires rebasing all or part of the stack anytime there are changes below the top of the stack (my 12-stack required at least ten rebases and half of those were non-trivial, taking up to 30-45 minutes -- and I'm always the fastest/most adept git conflict resolving specialist wherever I work, and usually, the guy everyone always DMs to do their complicated resolutions... so if it was a problem for me, it's going to be a nightmare for most devs)
- thus... it adds pressure on the dev to get the whole stack approved as quickly as possible, since the longer it goes without merging to main, the more times you'll have to rebase it; this adds the anxiety and severe annoyance of having a "[sword of Damocles](https://en.wikipedia.org/wiki/Sword_of_Damocles)" hanging over you
- ultimately it does not actually reduce the time to review a large set of changes, since the size of the set of changes being reviewed has not been reduced; if anything, it increases the time, and likely delays how soon the changes can merge vs. if it was just one branch
- if someone ELSE makes a stacked PR into your PR, now you have to rebase someone else's PR in order to catch up with main, and that's a recipe for disaster -- yet making a stacked PR into someone else's PR is probably the best use-case for this feature as it's much better alternative to a contentious code-review
- you can't create a tree structure of stacked PRs, even though there's no reason in git why you shouldn't be able to, and it would arguably simplify the rebasing in many cases if you structured the tree correctly
## Proposed Fix
Rather than have "Stacked PRs", instead enhance the "commit range" feature of PRs to work like described below. Imagine that you have a large branch MyBigBranch with lots of changes, which some reviewer says is "too big" or whatever other excuse they have for not being able to be arsed to actually review it despite being paid six figures.
I propose that github would allow a Stacked-PR-like interface that lets you:
- designate certain sets of changes in the PR as "Sub-PRs" that can receive individual reviews and approval
- create a dependency tree of "Sub-PRs" so it's clear which parts can be made into separate branches for individual merging/cherry-picking if needed without breaking the build
- not require individual CI builds per Sub-PR unless specified
- create "Sub-PRs" by commit messages automatically: "[Sub-1] Changes to file system monitor" ... "[Sub-2] Changes to File Tree UX" ... etc.
- create dependency between Sub-PRs similarly: "[Sub-1.1] File System data model update" "[Sub-1.2] File System monitor tests" "[Sub-1.1.1] File System Data Model tests" etc.
Sub-PRs would have the same benefit to reviewers of breaking up the process into individually reviewable chunks without all the downsides of Stacked PRs hat I listed above and in my linked post.
貢獻指南
研究方向
先整理 gh-stack 目前如何表示堆疊的 PR、提交範圍、相依性和 CI 行為;該 issue 沒有指定檔案、測試或進入點。在實作之前定義 Sub-PR 資料模型和工作流程邊界,其中完成意味著所提議的分組、審查、相依性和選用的 CI 行為能夠正常運作,而不要求每個 Sub-PR 使用一個分支。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- git, github, go
- 領域
- cli, developer-experience
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 活躍
- 描述清晰度
- 需要釐清
- 新手友好度
- 25/100