Skip to content
This repository has been archived by the owner on Sep 7, 2020. It is now read-only.

Hotfix/change commit message length related guidelines #1581

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

morantr
Copy link
Collaborator

@morantr morantr commented Aug 5, 2020

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.

@adam1985d
Copy link
Collaborator

adam1985d commented Aug 5, 2020

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.

Copy link
Collaborator

@RanRegev RanRegev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine with this change.
I think that terminals and GUIs in development environment has more than 80 chars limitations.
Setting it to 100 is fine, it also forces a strict and accurate commit subject sentence.
@adam1985d can you add a screenshot to support your concerns?

@VladyslavTupikin VladyslavTupikin self-requested a review August 5, 2020 11:43
@rmelotte
Copy link
Collaborator

rmelotte commented Aug 6, 2020

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?

Copy link
Collaborator

@itayx itayx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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.

Signed-off-by: Moran Shoeg <[email protected]>
@morantr morantr force-pushed the hotfix/change-commit-message-length-related-guidlines branch from bcde88d to 63dd0af Compare August 10, 2020 21:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants