|author||Josh Triplett <email@example.com>||2014-04-03 14:48:28 -0700|
|committer||Linus Torvalds <firstname.lastname@example.org>||2014-04-03 16:21:06 -0700|
SubmittingPatches: add style recommendation to use imperative descriptions
Most commit messages use this style, and the recommendation frequently comes up in discussions (especially in response to patches that don't use it), but that recommendation doesn't actually appear anywhere in Documentation. Add this style guideline to SubmittingPatches, using the description from git's SubmittingPatches. Signed-off-by: Josh Triplett <email@example.com> Acked-by: Borislav Petkov <firstname.lastname@example.org> Cc: Rob Landley <email@example.com> Cc: Randy Dunlap <firstname.lastname@example.org> Signed-off-by: Andrew Morton <email@example.com> Signed-off-by: Linus Torvalds <firstname.lastname@example.org>
Diffstat (limited to 'Documentation')
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 26b1e31d5a1..c74e73c37dc 100644
@@ -106,6 +106,11 @@ I.e., the patch (series) and its description should be self-contained.
This benefits both the patch merger(s) and reviewers. Some reviewers
probably didn't even receive earlier versions of the patch.
+Describe your changes in imperative mood, e.g. "make xyzzy do frotz"
+instead of "[This patch] makes xyzzy do frotz" or "[I] changed xyzzy
+to do frotz", as if you are giving orders to the codebase to change
If the patch fixes a logged bug entry, refer to that bug entry by
number and URL.