[DOCS-57] Should allow more than 50 characters in commit message for docs project Created: 19/Dec/17  Updated: 09/Jan/18  Resolved: 09/Jan/18

Status: Resolved
Project: docs
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Medium
Reporter: Kit Lou Assignee: Thanh Ha (zxiiro)
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

50 characters for commit message is a bit too limiting to fail a patch checkin.

Note these 2 patches:

66521: https://git.opendaylight.org/gerrit/#/c/66521/

66520: https://git.opendaylight.org/gerrit/#/c/66520/

66521 does not have the commit message length check in daexim and it passes, but 66520 fails because of this commit message check.

The number of characters allowed in commit message needs to be extended to something like 72.



 Comments   
Comment by Thanh Ha (zxiiro) [ 27/Dec/17 ]

Our configuration for this is configured in .coafile here: https://github.com/opendaylight/docs/blob/master/.coafile#L6-L12

and configuration options for this linter is available here:
https://github.com/coala/bear-docs/blob/master/docs/GitCommitBear.rst

Our current configuration has it as

Summary message (first line): 50 characters
Commit messages (lines after first line: 72 characters

This follows git commit message best practices as tools that parse git shortlog typically only read up to 50 characters of the first line thus if you have longer commit messages they will be truncated by most git shortlog tools anyway. We typically recommend our developers follow commit message standards as described by here:

https://chris.beams.io/posts/git-commit/

While I'm fine with changing this I do personally think following best practices especially so that parser tools properly parse our commit messages are a good idea. The first line of a commit message is supposed to be a subject line that's short and to the point with any description following it on later lines which do allow 72 character limits.

Comment by Thanh Ha (zxiiro) [ 09/Jan/18 ]

Discussed on the docs call we will keep the linter for commit message as is.

Generated at Wed Feb 07 19:58:33 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.