From 84c2537e4b5aff66bf6acfff6ccfb72dddd67028 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 4 Feb 2019 20:08:47 -0800 Subject: [PATCH] doc: revise Collaborator Guide on reverting Revise the "Reverting commits" section of the Collaborator Guide. Reduce passive voice. Increase clarity. --- COLLABORATOR_GUIDE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 232655e5ddb2f9..9bfc97147b994b 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -285,10 +285,10 @@ after-the-fact. ##### Reverting commits -Commits are reverted with `git revert `, or `git revert ..` for -multiple commits. Commit metadata and the reason for the revert should be -appended. Commit message rules about line length and subsystem can be ignored. -A Pull Request should be raised and approved like any other change. +Revert commits with `git revert ` or `git revert ..`. The +generated commit message will not have a subsystem and may violate line length +rules. That is OK. Append the reason for the revert and any `Refs` or `Fixes` +metadata. Raise a Pull Request like any other change. ### Introducing New Modules