Repository navigation
commitzen is not fully compatible with the latest conventional commit #199
Description
Type
- Conent inaccurate
URL
Just realize this tool is not using a conventional commit spec,
$ cz schema
<type>(<scope>): <subject>
<BLANK LINE>
(BREAKING CHANGE: )<body>
<BLANK LINE>
<footer>
Whereas in conventional commit spec, BREAKING CHANGE should belong to footer.
Description
Is it by design?
I don't think this is fully compatible with conventional commit. I think you may need to mention this explicitly.
Activity
[-][Documentation] Content to be added or fixed[/-][+]commitzen is not fully compatible with the latest conventional commit[/+]woile commentedon Jun 3, 2020
Hey! thanks for raising this issue.
It may not match with
v1.0.0, butv1.0.0-betasays:https://www.conventionalcommits.org/en/v1.0.0-beta/
if you only add body with this
commitizen, then the body is also, technically, the footer.If you use BREAKING CHANGE in a body or in a footer,
commitizenwon't care and will pick it up, so it doesn't really matter tocommitizen.I'd like to know how does this affect you, and if you could provide some use cases.
What do you think @Lee-W should we add a new patch to comply with
v1.0.0? I think the change would be small.guihao-liang commentedon Jun 3, 2020
Thanks for the prompt reply! Got it. I just want to know whether adding
BREAKING CHANGEto different places will cause any effect or not. I think it's better to mention this explicitly because I was reading the spec from 1.0.0 and I expectcommitizenwill comply with that spec. Other users may have the same expectations.One more question, does commitizen recognize
!?Lee-W commentedon Jun 4, 2020
@woile Yes, I think it would be better if we can comply with
v1.0.0.@guihao-liang Yes,
!is recognized in default.py. @woile I'm thinking of moving some of these defaults into conventional_commits.py. These defaults do not seem to make sense to other cz (e.g., cz_jira)woile commentedon Jun 4, 2020
Makes sense @Lee-W