Docs: fix grammar and explicit B1 config

Fix grammar in Rule 3 description and explicitly
configure body-max-line-length to 72 in .gitlint
so documentation accurately reflects configured
values rather than implicit defaults.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Andrew Grimberg <tykeal@bardicgrove.org>
This commit is contained in:
Andrew GrimbergandCopilot committed 2026-03-10 07:04:37 -07:00
1 parent 34cf5610bb
commit c300dd33ad
2 files changed
+4 -5

No files matched your search

+2 -3
View File
@@ -45,9 +45,8 @@ line-length=50
# (e.g. title-must-not-contain-word). # (e.g. title-must-not-contain-word).
# regex=^US[0-9]* # regex=^US[0-9]*
# [B1] [body-max-line-length]
# B1 = body-max-line-length line-length=72
# line-length=120
# [body-min-length] # [body-min-length]
# min-length=5 # min-length=5
+2 -2
View File
@@ -38,7 +38,7 @@ Keep subjects concise. The hard limit is 50 characters.
### Rule 3: Capitalize the subject line ### Rule 3: Capitalize the subject line
The subject line MUST start with a capital letter. This project uses The subject line MUST start with a capital letter. This project uses
Conventional Commits with capitalized types which naturally satisfies this rule. Conventional Commits, whose capitalized types naturally satisfy this rule.
- **Enforcement**: gitlint `contrib-title-conventional-commits` requires - **Enforcement**: gitlint `contrib-title-conventional-commits` requires
capitalized types. capitalized types.
@@ -76,7 +76,7 @@ Bad examples:
Body text MUST be wrapped at 72 characters per line. Lines containing URLs Body text MUST be wrapped at 72 characters per line. Lines containing URLs
MAY exceed this limit, but enforcement tooling has limitations. MAY exceed this limit, but enforcement tooling has limitations.
- **Enforcement**: gitlint `body-max-line-length` (default 72). The - **Enforcement**: gitlint `body-max-line-length` (configured to 72). The
configured `ignore-by-body` rule disables this check for the entire configured `ignore-by-body` rule disables this check for the entire
commit body if any line matches the URL pattern, so you MUST still commit body if any line matches the URL pattern, so you MUST still
manually wrap non-URL lines to 72 characters. manually wrap non-URL lines to 72 characters.