conventional-commits / conventionalcommits.org

The conventional commits specification

Home Page:https://conventionalcommits.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

what is the recommended way to handle deprecations?

bshaffer opened this issue · comments

I assume since it's neither a feat or a fix, the recommended way to handle deprecations would be chore(deprecation): or simply chore: deprecate such and such. But would a deprecated: tag or deprecation: tag also make sense? Curious if anyone has any thoughts on this.

My colleagues use deprecate: We don't like using feat: because we reserve it for introducing new features, and we don't like chore: either, because it doesn't convey a Semantic Versioning level. However, many guidelines based on conventional commits don't specify a type for deprecations.

Thoughts on feat(deprecate): Deprecate {{ thing }}? This would generate a feature release (as I would expect from a deprecation). One other option would be to use chore!: Deprecate {{ thing }}, but this equates to a MAJOR version change, which doesn't exactly feel right in all cases, especially since deprecation isn't truly a breaking change, just the first step in a breaking change. 🤷‍♂️

I'm here for the suggestions, as this feels like a common action that isn't called out in the spec.