Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT: prescribe ALL-CAPS type when commit includes breaking change #63

Closed

Conversation

apetro
Copy link
Contributor

@apetro apetro commented Jul 5, 2018

BREAKING CHANGE: requires type in ALL-CAPS when the commit includes a breaking change, whereas previously type would always be lowercase. Tools enforcing Conventional Commits as understood prior to this change may flag or fail to correctly parse commit messages indicating breaking changes under this version of the spec.

When a commit includes a breaking change, surely this is the most important thing to say about that commit. So lead with it. Indicating the breaking-change-ness of a commit it its header rather than just in its body and footer makes it easier to skim to, notice, and parse out (from abbreviated representations of the commit log) these changes.


This is another way of getting at the indicate-breaking-changes-in-the-header problem that #43 is trying to solve with a sigil. It might be that the sigil solution is better. I'm not sure that ALL-CAPS-ing the type: is the move to make here.

I do think something should be done to indicate the breakingness of changes in the header rather than only in the body or footer.

BREAKING CHANGE: requires type in ALL-CAPS when breaking change, whereas previously type would always be lowercase. Tools enforcing Conventional Commits as understood prior to this change may flag or fail to correctly parse commit messages indicating breaking changes under this version of the spec.

When a commit includes a breaking change, surely this is the most important thing to say about that commit. So lead with it. Indicating the breaking-change-ness of a commit it its header rather than just in its body and footer makes it easier to skim to, notice, and parse out (from abbreviated representations of the commit log) these changes.
@apetro
Copy link
Contributor Author

apetro commented Jul 5, 2018

Note that #24 might make the spec agnostic as to capitalization of type, or might prescribe sentence-case, either way at odds with making the capitalization of type semantically meaningful.

@damianopetrungaro
Copy link
Member

Hey @apetro!
As for the #64 please, open an issue before creating a PR trying to change the specs.
Here too I do not agree with the changes you proposed, see that imho it may create confusion and false positive.

Try to ping here -> #43 and let's see if it make sense add a sigil (or another way) to indicate BC in the message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants