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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: remove improvement #16

Merged
merged 1 commit into from
Dec 21, 2019
Merged

Conversation

AndersDJohnson
Copy link
Member

@AndersDJohnson AndersDJohnson commented Nov 3, 2019

I'm proposing we consider removing the improvement type, which is no longer recommended in the Conventional Commits spec. It was in their 1.0.0-beta.4 release, but removed in 1.0.0.

It was added here in #13, as did other tools like conventional-changelog/commitlint#832. But this addition was questioned in #15, which I'd agreed with per my comments #13 (review) and #15 (comment).

This also caused some other turbulence with other tools, such as commitizen/cz-cli#681 and conventional-changelog/commitlint#832.

Maybe it's too late? 馃し鈥嶁檪

@NathanUrwin
Copy link

@AndersDJohnson I do not think it is too late to remove improvement. Going forward in the future I believe exceptions can be made for the edge case commits that include the improvement type. I agree with your comment on #15 that this project follows the conventional commits specification, and does not make any type decisions itself.

@skeggse
Copy link

skeggse commented Nov 22, 2019

The good news is that it may not have spread too far: tools like semantic-release didn't start supporting the improvement commit type (ref semantic-release/commit-analyzer#149)

@jamime
Copy link

jamime commented Dec 4, 2019

I also came across this issue today when using commitizen with cz-conventional-changelog then using commitlint with @commitlint/config-conventional.

@skeggse
Copy link

skeggse commented Dec 16, 2019

@AndersDJohnson are there any blockers to moving forward with this change?

@AndersDJohnson
Copy link
Member Author

@skeggse None other than making sure we have consensus and an admin taking the time to merge it! Almost ready?

@sc250024
Copy link

Yes! This is interfering with commits as improvement is not in the spec.

@sc250024
Copy link

I also came across this issue today when using commitizen with cz-conventional-changelog then using commitlint with @commitlint/config-conventional.

Ditto

@AndersDJohnson AndersDJohnson merged commit 958396a into master Dec 21, 2019
@AndersDJohnson AndersDJohnson deleted the feat-remove-improvement branch December 21, 2019 00:26
@AndersDJohnson
Copy link
Member Author

Released and published as v3.0.0!

amannn added a commit to amannn/action-semantic-pull-request that referenced this pull request Sep 17, 2020
BREAKING CHANGE: Remove support for `improvement` prefix (as per commitizen/conventional-commit-types#16).
amannn added a commit to amannn/action-semantic-pull-request that referenced this pull request Sep 17, 2020
BREAKING CHANGE: Remove support for `improvement` prefix (as per commitizen/conventional-commit-types#16).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants