From e72f590477936f02b707b1ec75c64a646257aa8d Mon Sep 17 00:00:00 2001 From: Patrick Donnelly Date: Tue, 6 Aug 2019 07:20:47 -0700 Subject: [PATCH] doc: indicate imperative mood for commit titles This is convention in the kernel and Ceph but is not clearly documented. Signed-off-by: Patrick Donnelly --- SubmittingPatches.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/SubmittingPatches.rst b/SubmittingPatches.rst index a13191d8572..601e88223d6 100644 --- a/SubmittingPatches.rst +++ b/SubmittingPatches.rst @@ -397,12 +397,20 @@ could be "doc:", "osd:", or "common:". One can use:: git log -for more examples. Please use this "subsystem: short description" -convention for naming pull requests (PRs) also, as it feeds directly -into the script that generates release notes and it's tedious to clean -up at release time. This document places no limit on the length of PR -titles, but be aware that they are subject to editing as part of the -release process. +for more examples. It is also conventional to use the imperative mood in the +commit title. For example:: + + mds: add perf counter for finisher of MDSRank + +or:: + + osd: make the ClassHandler::mutex private + +For GitHub, please use this "subsystem: short description" convention for +naming pull requests (PRs). These titles feed directly into the script that +generates release notes and it is tedious to clean up non-conformant PR titles +at release time. This document places no limit on the length of PR titles, but +be aware that they are subject to editing as part of the release process. Commit message ^^^^^^^^^^^^^^