From a2e1320b2e1ce266d621ec036d15b9c8cbdb2500 Mon Sep 17 00:00:00 2001 From: Doug Evans Date: Thu, 25 Jan 2024 11:09:33 -0800 Subject: [PATCH] Clarify commit summary text for non-issue related commits Some non-issue related commits prefix the summary with "iX:". Thus if one is looking at the output of "git log" to find the required format one will come to the wrong conclusion. Make it clear in the docs what the rule is. --- api/docs/code_reviews.dox | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/api/docs/code_reviews.dox b/api/docs/code_reviews.dox index 05fee6e124a..5dcc5d6d5a3 100644 --- a/api/docs/code_reviews.dox +++ b/api/docs/code_reviews.dox @@ -79,7 +79,16 @@ can select a particular reviewer if desired. \section sec_commit_messages Commit Messages -Commit messages should include an initial title line separated from the body of the message by a blank line. The title line should be a concise summary and should start with the issue number followed by a colon which is followed by the description of the issue fix. If the issue is fixed by more than one commit, the title should instead start with the issue number followed by a space and a short issue description, then a colon, and then a description of this particular fix, with a reference to the issue at the bottom for automatic linking in Github. In either case, the body of the message should elaborate on the contents of the commit using complete sentences. +Commit messages should include an initial title line separated from the body of +the message by a blank line. The title line should be a concise summary and +should start with the issue number followed by a colon which is followed by the +description of the issue fix. If there is no issue just write the summary, +don't prefix it with, e.g., "iX:". If the issue is fixed by more than one +commit, the title should instead start with the issue number followed by a +space and a short issue description, then a colon, and then a description of +this particular fix, with a reference to the issue at the bottom for automatic +linking in Github. In either case, the body of the message should elaborate +on the contents of the commit using complete sentences. For a commit that fixes an Issue, be sure to resolve the Issue with a message indicating the commit revision number. If you use the exact string