[Feature Request] Allow Sub-PRs (one branch with commits grouped into Sub-PRs) instead of one-branch-per-Stacked-PR

オープン
#436 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
活発
技術スタック
git, github, go

調査の方向性

まず、gh-stack が現在、積み重ねられた PR、コミット範囲、依存関係、CI の動作をどのように表現しているかを整理すること。issue ではファイル、テスト、エントリーポイントは指定されていない。実装前に Sub-PR のデータモデルとワークフローの境界を定義し、完了とは、Sub-PR ごとに 1 つのブランチを必要とせずに、提案されたグループ化、レビュー、依存関係、およびオプションの CI 動作が機能することを意味する。

索引モデルが issue の本文から書いたものです。

説明

The problem

Based on my experience making a stack of 12 PRs to an open source repo , 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" 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.

主要言語
Go
スター
1.5k
フォーク
73
平均マージ
1日 8時間
マージ済み PR(30日)
7

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

github/gh-stack のほかの issue

github/gh-stack の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。