Skip to content

Commit 3b74cc6

Browse files
Trottaddaleax
authored andcommitted
doc: revise Collaborator Guide on reverting
Revise the "Reverting commits" section of the Collaborator Guide. Reduce passive voice. Increase clarity. PR-URL: #25942 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
1 parent c457d00 commit 3b74cc6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

COLLABORATOR_GUIDE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -285,10 +285,10 @@ after-the-fact.
285285

286286
##### Reverting commits
287287

288-
Commits are reverted with `git revert <HASH>`, or `git revert <FROM>..<TO>` for
289-
multiple commits. Commit metadata and the reason for the revert should be
290-
appended. Commit message rules about line length and subsystem can be ignored.
291-
A Pull Request should be raised and approved like any other change.
288+
Revert commits with `git revert <HASH>` or `git revert <FROM>..<TO>`. The
289+
generated commit message will not have a subsystem and may violate line length
290+
rules. That is OK. Append the reason for the revert and any `Refs` or `Fixes`
291+
metadata. Raise a Pull Request like any other change.
292292

293293
### Introducing New Modules
294294

0 commit comments

Comments
 (0)