mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2026-03-22 12:44:37 -05:00
[PR #63] [CLOSED] FEAT: prescribe ALL-CAPS type when commit includes breaking change #272
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/conventional-commits/conventionalcommits.org/pull/63
Author: @apetro
Created: 7/5/2018
Status: ❌ Closed
Base:
master← Head:emphasize-breaking-changes📝 Commits (1)
3e8a547FEAT: prescribe ALL-CAPS type when commit includes breaking change📊 Changes
1 file changed (+4 additions, -2 deletions)
View changed files
📝
index.md(+4 -2)📄 Description
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.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.