aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEd Maste <emaste@FreeBSD.org>2024-11-11 17:41:33 +0000
committerEd Maste <emaste@FreeBSD.org>2025-07-31 15:06:17 +0000
commitba39086dd26235d09c710c91f31a5da45096f430 (patch)
treea6ff28e3721853ef05fecfa48cbf59061b1e114c
parent9ca5dd5ef904d2cff77a1ac241cf6ab3d26aad84 (diff)
committers-guide: Increase subject length limit to 67 characters
I originally suggested a 63-character limit "so that git log --oneline avoids wrapping." Short hashes in the tree are typically 12 characters, and a space between the hash and the subject should result in a limit of 67 characters. I think I arrived at 63 by subtracting git's typical 4-space indentation from 67, but that indent is not applicable to `git log --oneline`. Reviewed by: olce Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48246
-rw-r--r--documentation/content/en/articles/committers-guide/_index.adoc4
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc
index dc3e6a4679..0b23426894 100644
--- a/documentation/content/en/articles/committers-guide/_index.adoc
+++ b/documentation/content/en/articles/committers-guide/_index.adoc
@@ -2480,7 +2480,7 @@ The subject should, by itself, allow the reader to quickly determine if the chan
The subject line should be as short as possible while still retaining the required information.
This is to make browsing Git log more efficient, and so that git log --oneline can display the short hash and subject on a single 80-column line.
-A good rule of thumb is to stay below 63 characters, and aim for about 50 or fewer if possible.
+A good rule of thumb is to stay below 67 characters, and aim for about 50 or fewer if possible.
=== Prefix the subject line with a component, if applicable
@@ -2489,7 +2489,7 @@ If applicable, try to use the same prefix used in previous commits to the same f
✓ `foo: Add -k option to keep temporary data`
-Include the prefix in the 63-character limit suggested above, so that `git log --oneline` avoids wrapping.
+Include the prefix in the 67-character limit suggested above, so that `git log --oneline` avoids wrapping.
=== Capitalize the first letter of the subject