Skip to content

Commit 97e3fea

Browse files
committed
proofreading
1 parent 5bb31d6 commit 97e3fea

7 files changed

Lines changed: 31 additions & 31 deletions

File tree

docs/src/content/docs/faq.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ description: Frequently asked questions about GitHub Stacked PRs.
55

66
## Creating Stacked PRs
77

8-
### What is a stacked PR? How is it different from a regular PR?
8+
### What is a Stacked PR? How is it different from a regular PR?
99

10-
A stacked PR is a pull request that is part of an ordered chain of PRs, where each PR targets the branch of the PR below it instead of targeting `main` directly. Each PR in the stack represents one focused layer of a larger change. Individually, each PR is still a regular pull request — it just has a different base branch and GitHub understands the relationship between the PRs in the stack.
10+
A Stacked PR is a pull request that is part of an ordered chain of PRs, where each PR targets the branch of the PR below it instead of targeting `main` directly. Each PR in the stack represents one focused layer of a larger change. Individually, each PR is still a regular pull request — it just has a different base branch, and GitHub understands the relationship between the PRs in the stack.
1111

12-
### How do I create a stacked PR?
12+
### How do I create a Stacked PR?
1313

1414
You can create a stack using the `gh stack` CLI:
1515

@@ -27,13 +27,13 @@ You can also create stacks entirely from the GitHub UI — create the first PR n
2727

2828
### How do I add PRs to my stack?
2929

30-
Use `gh stack add <branch-name>` to add a new branch on top of the current stack. When you run `gh stack submit`, a PR is created for each branch and they are linked together as a Stack on GitHub.
30+
Use `gh stack add <branch-name>` to add a new branch on top of the current stack. When you run `gh stack submit`, a PR is created for each branch, and they are linked together as a Stack on GitHub.
3131

3232
You can also add PRs to an existing stack from the GitHub UI. See [Adding to an Existing Stack](/gh-stack/guides/ui/#adding-to-an-existing-stack) for details.
3333

3434
### How can I modify my stack?
3535

36-
Reordering or inserting branches into the middle of a stack is not currently supported. To restructure a stack, use `gh stack unstack` to tear it down and then recreate it with `gh stack init --adopt`:
36+
Reordering or inserting branches into the middle of a stack is not currently supported. To restructure a stack, use `gh stack unstack` to tear it down and then re-create it with `gh stack init --adopt`:
3737

3838
```sh
3939
# 1. Remove the stack
@@ -54,26 +54,26 @@ gh stack init --adopt branch-2 branch-1 branch-3
5454

5555
### Can stacks be created across forks?
5656

57-
No, stacked PRs currently require all branches to be in the same repository. Cross-fork stacks are not supported.
57+
No, Stacked PRs currently require all branches to be in the same repository. Cross-fork stacks are not supported.
5858

5959
## Checks, Rules & Requirements
6060

61-
### How are branch protection rules evaluated for stacked PRs?
61+
### How are branch protection rules evaluated for Stacked PRs?
6262

6363
Every PR in a stack is treated as if it is targeting the **base of the stack** (typically `main`), regardless of which branch it directly targets. This means:
6464

6565
- **Required reviews** are evaluated as if the PR is targeting the stack base.
6666
- **Required status checks** are evaluated as if the PR is targeting the stack base.
67-
- **CODEOWNERS** are evaluated from the stack base — changes in codeowners on a PR at the bottom of the stack will not affect PRs above it in the stack.
67+
- **CODEOWNERS** are evaluated from the stack base — changes in `CODEOWNERS` on a PR at the bottom of the stack will not affect PRs above it in the stack.
6868
- **Code scanning workflows** are evaluated as if the PR is targeting the stack base.
6969

70-
### How do GitHub Actions work with stacked PRs?
70+
### How do GitHub Actions work with Stacked PRs?
7171

7272
GitHub Actions workflows trigger as if each PR in the stack is targeting the base of the stack (e.g., `main`). If you have a workflow configured to run on `pull_request` events targeting `main`, it will run for **every PR in the stack** — not just the bottom one.
7373

7474
### Do all previous PRs need to be passing checks before I can merge?
7575

76-
Yes. In order to merge a PR in the stack, **all PRs below it** must also have passing checks and meet all merge requirements. For example, in a stack of `main <- PR1 <- PR2 <- PR3` and you want to merge PR #3, both PR #1 and PR #2 must have passing checks, required reviews, and satisfy all branch protection rules.
76+
Yes. In order to merge a PR in the stack, **all PRs below it** must also have passing checks and meet all merge requirements. For example, in a stack of `main <- PR1 <- PR2 <- PR3`, if you want to merge PR #3, both PR #1 and PR #2 must have passing checks, required reviews, and satisfy all branch protection rules.
7777

7878
### Is a linear history required?
7979

@@ -86,13 +86,13 @@ If the stack is not linear (e.g., after changes were pushed to a lower branch),
8686

8787
## Merging Stacked PRs
8888

89-
### What conditions need to be met for a stacked PR to be mergeable?
89+
### What conditions need to be met for a Stacked PR to be mergeable?
9090

9191
Every PR in a stack must meet the same merge requirements as a PR targeting the stack base (e.g., `main`): required reviews, passing CI checks, CODEOWNER approvals, and a linear history. All PRs below it must also meet these requirements. See the [Checks, Rules & Requirements](#checks-rules--requirements) section above for details.
9292

9393
### How does merging a stack of PRs differ from merging a regular PR?
9494

95-
Stacks must be merged **from the bottom up**. You can merge the bottom PR (and all non-merged PRs below it) in a single operation. After a PR is merged, the remaining stack is automatically rebased so the next PR targets `main` directly.
95+
Stacks must be merged **from the bottom up**. When you merge a PR, all non-merged PRs below it in the stack are also merged. After a PR is merged, the remaining stack is automatically rebased so the next PR targets `main` directly.
9696

9797
### What happens when you merge a PR in the middle of the stack?
9898

@@ -114,23 +114,23 @@ With rebase merge, all of the commits from each PR in the stack are replayed ont
114114

115115
PRs in a stack are merged sequentially, from the bottom up. When you initiate a merge, the bottom PR is merged first, and then the next PR above it, and so on.
116116

117-
There will not be a single push operation that adds all the commits from all the branches at once.
117+
Commits are not all landed in a single atomic operation — each PR is merged individually in sequence.
118118

119119
### Can I merge only part of a stack? What happens to the remaining unmerged PRs?
120120

121-
Yes, partial stack merges are supported. After the merge, the lowest unmerged PR is updated to explicitly target the stack base (e.g. `main`). A cascading rebase is also automatically run to rebase the remaining unmerged branches.
121+
Yes, partial stack merges are supported. After the merge, the lowest unmerged PR is updated to explicitly target the stack base (e.g., `main`). A cascading rebase is also automatically run to rebase the remaining unmerged branches.
122122

123123
### What happens if you close a PR in the middle of the stack?
124124

125-
Closing a PR in the middle of the stack will block all PRs above it from being mergeable. The stack relationship is preserved, so if you want to open a different PR or modify the stack, you will need to unstack and then recreate the stack.
125+
Closing a PR in the middle of the stack will block all PRs above it from being mergeable. The stack relationship is preserved, so if you want to open a different PR or modify the stack, you will need to unstack and then re-create the stack.
126126

127127
### What happens when there is an error merging a PR in the middle of a stack?
128128

129129
If a merge fails (e.g., due to a failing check or merge conflict), the operation stops and no subsequent PRs are merged. You'll need to resolve the issue before continuing.
130130

131-
### Does Stacked PRs support merge queue?
131+
### Do Stacked PRs support merge queue?
132132

133-
Yes, stacked PRs fully support merging via merge queue. When you merge a stack through the merge queue:
133+
Yes, Stacked PRs fully support merging via merge queue. When you merge a stack through the merge queue:
134134

135135
- **All PRs in the stack are added to the queue** in the correct order, ensuring a linear sequence.
136136
- **If a PR is removed or ejected from the merge queue**, all PRs above it in the stack are also ejected and removed from the queue.
@@ -154,7 +154,7 @@ No. Stacked PRs are built on standard git branches and regular pull requests. Yo
154154

155155
### Will this work with a different tool for stacking?
156156

157-
Yes, you can continue to use your tool of choice (e.g. jj, Sapling, ghstack, git-town, etc.) to manage stacks locally and push up your branches to GitHub.
157+
Yes, you can continue to use your tool of choice (e.g., jj, Sapling, ghstack, git-town, etc.) to manage stacks locally and push up your branches to GitHub.
158158

159159
Stacked PRs on GitHub are based on the standard pull request model — any tool that creates PRs with the correct base branches can work with them. The `gh stack` CLI is purpose-built for the GitHub experience, but other tools that manage branch chains should be compatible.
160160

docs/src/content/docs/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Quick Start
3-
description: Install the gh stack CLI and create your first stacked PR in minutes.
3+
description: Install the gh stack CLI and create your first Stacked PR in minutes.
44
---
55

66
## Prerequisites

docs/src/content/docs/guides/stacked-prs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Practical guide for reviewing, merging, and managing stacked pull r
55

66
This guide covers the practical day-to-day experience of working with Stacked PRs — how to review them, how merging works step by step, and how to keep things in sync from the CLI.
77

8-
For an introduction to what stacks are and how GitHub supports them natively, see the [Overview](/gh-stack/introduction/overview/). For a visual walkthrough of the UI, see [Using Stacks in the GitHub UI](/gh-stack/guides/ui/).
8+
For an introduction to what stacks are and how GitHub supports them natively, see the [Overview](/gh-stack/introduction/overview/). For a visual walkthrough of the UI, see [Stacked PRs in the GitHub UI](/gh-stack/guides/ui/).
99

1010
## Reviewing Stacked PRs
1111

docs/src/content/docs/guides/ui.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Stacked PRs in the GitHub UI
3-
description: A visual walkthrough of creating, navigating, merging, and managing stacked PRs directly in the GitHub pull request UI.
3+
description: A visual walkthrough of creating, navigating, merging, and managing Stacked PRs directly in the GitHub pull request UI.
44
---
55

66
This guide walks through the key UI components and workflows for working with Stacked PRs on GitHub.
@@ -51,7 +51,7 @@ If a stack already exists and you want to add a new PR to it:
5151

5252
![Adding a new PR to an existing stack](../../../assets/screenshots/add-to-existing-stack.png)
5353

54-
2. On the following page, the base branch is automatically set to the head of the top-most PR. Select the head branch for your new PR and click **Create pull request**.
54+
2. On the following page, the base branch is automatically set to the head of the topmost PR. Select the head branch for your new PR and click **Create pull request**.
5555

5656
![Selecting branch to add to stack](../../../assets/screenshots/selecting-branch-to-add.png)
5757

@@ -79,7 +79,7 @@ Before a PR in the stack can be merged, the following conditions must be met:
7979

8080
## Unstacking
8181

82-
If you want to reorder or reorganize the PRs in a stack, you must first dissolve the stack and then recreate it. You can unstack PRs from the UI.
82+
If you want to reorder or reorganize the PRs in a stack, you must first dissolve the stack and then re-create it. You can unstack PRs from the UI.
8383

8484
### Dissolving the Entire Stack
8585

docs/src/content/docs/guides/workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ This command:
135135
4. Pushes the updated branches
136136
5. Syncs PR state from GitHub
137137

138-
If a conflict is detected during the rebase, all branches are restored to their original state and you're advised to run `gh stack rebase` to resolve conflicts interactively.
138+
If a conflict is detected during the rebase, all branches are restored to their original state, and you're advised to run `gh stack rebase` to resolve conflicts interactively.
139139

140140
## Structuring Your Stack
141141

docs/src/content/docs/introduction/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ While the PR UI provides the review and merge experience, the `gh stack` CLI han
9191
- **Tearing down stacks**`gh stack unstack` removes a stack from GitHub and local tracking if you need to restructure it.
9292
- **Checking out a stack**`gh stack checkout <pr-number>` pulls down a stack, with all its branches, from GitHub to your local machine.
9393

94-
The CLI is not required to use Stacked PRs — the underlying git operations are standard. But it makes the workflow simpler, and you can create Stacked PRs from CLI instead of the UI.
94+
The CLI is not required to use Stacked PRs — the underlying git operations are standard. But it makes the workflow simpler, and you can create Stacked PRs from the CLI instead of the UI.
9595

9696
## Thinking About Stack Structure
9797

docs/src/content/docs/reference/cli.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Check out a stack from a pull request number or branch name.
138138
gh stack checkout [<pr-number> | <branch>]
139139
```
140140

141-
When a PR number is provided (e.g. `123`), the command fetches the stack on GitHub, pulls the branches, and sets up the stack locally. If the stack already exists locally and matches, it switches to the branch. If the local and remote stacks have different compositions, you'll be prompted to resolve the conflict.
141+
When a PR number is provided (e.g., `123`), the command fetches the stack on GitHub, pulls the branches, and sets up the stack locally. If the stack already exists locally and matches, it switches to the branch. If the local and remote stacks have different compositions, you'll be prompted to resolve the conflict.
142142

143143
When a branch name is provided, the command resolves it against locally tracked stacks only.
144144

@@ -197,11 +197,11 @@ gh stack sync [flags]
197197

198198
Performs a safe, non-interactive synchronization of the entire stack:
199199

200-
1. **Fetch** — fetches the latest changes from `origin`
201-
2. **Fast-forward trunk** — fast-forwards the trunk branch to match the remote (skips if diverged)
202-
3. **Cascade rebase** — rebases all stack branches onto their updated parents (only if trunk moved). If a conflict is detected, all branches are restored to their original state and you are advised to run `gh stack rebase` to resolve conflicts interactively
203-
4. **Push** — pushes all branches (uses `--force-with-lease` if a rebase occurred)
204-
5. **Sync PRs** — syncs PR state from GitHub and reports the status of each PR
200+
1. **Fetch** — fetches the latest changes from `origin`.
201+
2. **Fast-forward trunk** — fast-forwards the trunk branch to match the remote (skips if diverged).
202+
3. **Cascade rebase** — rebases all stack branches onto their updated parents (only if trunk moved). If a conflict is detected, all branches are restored to their original state, and you are advised to run `gh stack rebase` to resolve conflicts interactively.
203+
4. **Push** — pushes all branches (uses `--force-with-lease` if a rebase occurred).
204+
5. **Sync PRs** — syncs PR state from GitHub and reports the status of each PR.
205205

206206
| Flag | Description |
207207
|------|-------------|

0 commit comments

Comments
 (0)