search

conventional-changelog / commitlint

📓 Lint commit messages
https://commitlint.js.org
MIT License
16.71k stars 899 forks source link

Why is `header-max-length` 72 by default? #4092

Closed musjj closed 3 months ago

musjj commented 3 months ago

I know this can be configured, but is there a reason why it's not set to the popular 50/72 convention by default?

escapedcat commented 3 months ago

50/72 convention

What's this? Can you elaborate?

Which config do you use?\ Afaik "conventional-changelog" should use a 100 currently

musjj commented 3 months ago

Ah yeah, sorry about that, it's actually 100. I saw the default value here: https://commitlint.js.org/reference/rules.html#header-max-length and assumed that @commitlint/config-conventional is using the same value.

A popular convention is to limit the header line by 50 chars and the body by 72 chars.

I think the most authoritative origin I can find of this convention is this snippet from git help commit:

Though not required, it’s a good idea to begin the commit message with a single short (no more than 50 characters) line summarizing the change, followed by a blank line and then a more thorough description. The...

But since it's 100 by default, I guess it never followed this convention in the first place. I'll close this for now.

escapedcat commented 3 months ago

Ah, got it, thanks for the extra info!
Happy for a PR to adjust the docs though ;)