https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/DOCS-57 docs <p>50 characters for commit message is a bit too limiting to fail a patch checkin.</p> <p>Note these 2 patches:</p> <p>66521: <a href="https://git.opendaylight.org/gerrit/#/c/66521/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/66521/</a></p> <p>66520: <a href="https://git.opendaylight.org/gerrit/#/c/66520/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/66520/</a></p> <p>66521 does not have the commit message length check in daexim and it passes, but 66520 fails because of this commit message check.</p> <p>The number of characters allowed in commit message needs to be extended to something like 72.</p> DOCS-57

Should allow more than 50 characters in commit message for docs project

Improvement Medium Resolved Won't Do Thanh Ha (zxiiro) Kit Lou Tue, 19 Dec 2017 18:06:17 +0000 Tue, 9 Jan 2018 20:22:47 +0000 Tue, 9 Jan 2018 20:22:47 +0000 0 2 <p>Our configuration for this is configured in .coafile here: <a href="https://github.com/opendaylight/docs/blob/master/.coafile#L6-L12" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/opendaylight/docs/blob/master/.coafile#L6-L12</a></p> <p>and configuration options for this linter is available here:<br/> <a href="https://github.com/coala/bear-docs/blob/master/docs/GitCommitBear.rst" class="external-link" target="_blank" rel="nofollow noopener">https://github.com/coala/bear-docs/blob/master/docs/GitCommitBear.rst</a></p> <p>Our current configuration has it as</p> <p>Summary message (first line): 50 characters<br/> Commit messages (lines after first line: 72 characters</p> <p>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:</p> <p><a href="https://chris.beams.io/posts/git-commit/" class="external-link" target="_blank" rel="nofollow noopener">https://chris.beams.io/posts/git-commit/</a></p> <p>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.</p> <p>Discussed on the docs call we will keep the linter for commit message as is.</p> Development Rank 0|i0394f: