Skip to content

[llvm][docs] Reorder Stacked PR approaches in GitHub.rst #138126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions llvm/docs/GitHub.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,16 +254,6 @@ To illustrate, assume that you are working on two branches in your fork of the

Your options are as follows:

#. Two PRs with a dependency note

Create PR_1 for `feature_1` and PR_2 for `feature_2`. In PR_2, include a
note in the PR summary indicating that it depends on PR_1 (e.g.,
“Depends on #PR_1”).

To make review easier, make it clear which commits are part of the base PR
and which are new, e.g. "The first N commits are from the base PR". This
helps reviewers focus only on the incremental changes.

#. Use user branches in ``llvm/llvm-project``

Create user branches in the main repository, as described
Expand All @@ -274,8 +264,22 @@ Your options are as follows:

This approach allows GitHub to display clean, incremental diffs for each PR
in the stack, making it much easier for reviewers to see what has changed at
each step. Once `feature_1` is merged, you can rebase and re-target
`feature_2` to `main`.
each step. Once `feature_1` is merged, GitHub will automatically rebase and
re-target your branch `feature_2` to `main`. For more complex stacks, you can
perform this step using the web interface.

This approach requires commit access. See how to obtain it
`here <https://llvm.org/docs/DeveloperPolicy.html#obtaining-commit-access>`_.

#. Two PRs with a dependency note

Create PR_1 for `feature_1` and PR_2 for `feature_2`. In PR_2, include a
note in the PR summary indicating that it depends on PR_1 (e.g.,
“Depends on #PR_1”).

To make review easier, make it clear which commits are part of the base PR
and which are new, e.g. "The first N commits are from the base PR". This
helps reviewers focus only on the incremental changes.

#. Use a stacked PR tool

Expand Down
Loading