prplMesh icon indicating copy to clipboard operation
prplMesh copied to clipboard

Hotfix/change commit message length related guidelines

Open morantr opened this issue 5 years ago • 2 comments

Change the limitation on the git commit subject to 72 which is the limit which passing it will cause GitHub to wrap the line with "...": "prefix: This is an example to a commit message subject that exceeding 72 c... arecters"

Change the commit extended description length limitation to 100 characters. The git log looks fine with this limitation, and since we set the code line limitation to 100, there is no reason not to apply the same limitation on the commit message.

morantr avatar Aug 05 '20 07:08 morantr

Change the limitation on the git commit subject to 72 which is the limit which passing it will cause GitHub to wrap the line with "...": "prefix: This is an example to a commit message subject that exceeding 72 c... arecters"

Change the commit extended description length limitation to 100 characters. The git log looks fine with this limitation, and since we set the code line limitation to 100, there is no reason not to apply the same limitation on the commit message.

The origin of the limitations was to allow comfortable reading of commits using the "git log" (and out aliases "gitlog") in the developer shell. If this hasn't changed - and as far as I know it didn't - your PR will break the git log prints readability.

adam1985d avatar Aug 05 '20 10:08 adam1985d

Wrapping the commit descriptions at 72-75 characters is very common across open source projects, I don't really see the benefit of switching to 100... Commit descriptions are mostly made of sentences, not code, so to me it makes sense to have different rules for it. Shall we also vote on that?

rmelotte avatar Aug 06 '20 07:08 rmelotte