Skip to content

Commit 8f76b98

Browse files
authored
Merge pull request #982 from jieyouxu/rollup-merge-commit
Update revert docs
2 parents 3cae972 + 05ebdb7 commit 8f76b98

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

src/compiler/revert-button.png

-20.6 KB
Binary file not shown.

src/compiler/reviews.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -312,17 +312,16 @@ members pointing to this PR, or it's simply obvious to everyone involved). Only
312312
certainty if the issue is particularly critical or urgent to fix.
313313

314314
#### Creating reverts
315-
The easiest method for creating a revert is to use the "Revert" button on Github. This appears
316-
next to the "bors merged commit abcd" message on a pull request, and creates a new pull request.
317-
318-
![Location of the "Revert" button](revert-button.png)
319-
320-
Alternatively, a revert commit can be created using the git CLI and then uploaded as a pull request:
315+
A revert commit can be created using the git CLI and then uploaded as a pull request:
321316

322317
```terminal
323-
$ git revert -m 1 62d5bee
318+
$ git revert -m 1 $COMMIT_HASH
324319
```
325320

321+
where `$COMMIT_HASH` can be found next to the merged status message:
322+
323+
![merged commit hash](./reviews/merged-commit-hash.png)
324+
326325
Don't rely *only* on the default commit title and message created by git. Instead, title the revert
327326
commit meaningfully, and link to the relevant PR that introduced the regression. Link to the
328327
specific PR that is being fully or partially reverted. Link to relevant issues and discussions.
18.9 KB
Loading

0 commit comments

Comments
 (0)