File tree Expand file tree Collapse file tree 3 files changed +14
-6
lines changed
Expand file tree Collapse file tree 3 files changed +14
-6
lines changed Original file line number Diff line number Diff line change @@ -9,13 +9,14 @@ request. When you update a PR, jip posts a comment showing what you changed
99
1010## Features
1111
12- - ** One commit = one PR** — each commit gets its own focused, reviewable PR
12+ - ** One commit = one PR** — each commit gets its own focused, reviewable PR,
13+ with title and description taken from the commit message
1314- ** Review comments on update** — when you update a PR, jip posts a diff
1415 showing only what you changed (rebase noise is filtered out)
1516- ** Automatic bookmarks** — no need to manually create jj bookmarks
1617- ** Fork workflow** — works without write access to the target repo
1718- ** Normal GitHub merge** — no special "land" command, just merge PRs as usual
18- - ** Merge commits in stacks ** — supports non-linear revision graphs
19+ - ** Stacks may contain merge commits ** — supports non-linear revision graphs
1920
2021## Installation
2122
Original file line number Diff line number Diff line change @@ -16,14 +16,17 @@ highlighted commit (5670b0e in the screenshot above).
1616
1717## How to review
1818
19- ### The simple approach (recommended for most reviewers)
19+ ### The standard approach
2020
21211 . ** Start from the bottom of the stack** (PR #1 in the example above).
22222 . ** Review only the commit highlighted in the description.** Each PR is one
2323 self-contained change.
24- 3 . ** Approve or request changes** as you would with any normal PR.
25- 4 . ** Merge from the bottom up.** Merge PR #1 first. The PR author will then
26- rebase and update the remaining PRs so PR #2 targets ` main ` directly.
24+ 3 . ** Approve or request changes** as you would with any normal PR. If the
25+ highlighted commit of the PR looks good, approve the PR, even if some
26+ earlier PR in the chain might require a fix.
27+ 4 . ** Merge from the bottom up.** Merge PR #1 first, then PR #2 etc. The PR
28+ author will rebase and update the remaining PRs if necessary (e.g. if GitHub
29+ claims there is a conflict).
2730
2831### The minimal approach (if stacked PRs feel overwhelming)
2932
Original file line number Diff line number Diff line change @@ -30,6 +30,10 @@ this to GitHub's PR model by turning each commit into its own PR.
3030
3131## The force-push problem
3232
33+ If a commit is the unit of review it means that any improvements that are
34+ uncovered during review need to be fixed by amending the commit, which in turn
35+ means you need to force push the PR branch.
36+
3337When you update a PR by force-pushing, GitHub shows the full diff against the
3438base branch but provides no good way to see * what changed since the last
3539review* . Reviewers are left re-reading the entire PR or mentally diffing
You can’t perform that action at this time.
0 commit comments