fix: prefer description over BREAKING CHANGE #45
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The conventional commit specification says the following about breaking changes indicated with ! after the type and BREAKING CHANGE footers: > If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change. This updates the commit parser to prefer the description from the subject line over the value of the BREAKING CHANGE footer when both describe breaking changes. This is more inline with the specification and also allows consumers to enumerate all breaking change descriptions in the case where the subject and footers are used to list more than one breaking change.
Insomniak47
approved these changes
Aug 7, 2023
|
Thanks @Insomniak47 but I shared this PR because I thought you'd be interested not because I needed a +1 from you 😂. Friends don't let friends review un-caffeinated. |
|
I've created conventional-commits/conventionalcommits.org#535 to get clarification on this because, while I can understand this interpretation of the spec, it seems wrong to me. |
Thanks for the reply. I'll reply on the issue you created there since we're talking about the spec rather than the implementation. |
Thiernosy82
approved these changes
Aug 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The conventional commit specification says the following about breaking changes indicated with ! after the type and BREAKING CHANGE footers:
This updates the commit parser to prefer the description from the subject line over the value of the BREAKING CHANGE footer when both describe breaking changes. This is more inline with the specification and also allows consumers to enumerate all breaking change descriptions in the case where the subject and footers are used to list more than one breaking change.