docs: add version bump annotations to all commit type descriptions#1875
Open
danielalanbates wants to merge 1 commit intocommitizen-tools:masterfrom
Open
docs: add version bump annotations to all commit type descriptions#1875danielalanbates wants to merge 1 commit intocommitizen-tools:masterfrom
danielalanbates wants to merge 1 commit intocommitizen-tools:masterfrom
Conversation
Add SemVer version bump information to all commit type descriptions in the interactive prompt, info text, and writing commits documentation. Previously, only `feat` and `fix` indicated their SemVer correlation. Now `refactor` and `perf` explicitly state they correlate with PATCH, and `docs`, `style`, `test`, `build`, and `ci` explicitly state they do not trigger a version bump. This addresses the remaining task from issue commitizen-tools#515 which requested that commit message instructions identify what version bump occurs with all change types. Closes commitizen-tools#515 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
danielalanbates
requested review from
Lee-W,
noirbizarre and
woile
as code owners
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Adds SemVer version bump information to all commit type descriptions, addressing the remaining task from #515.
PR #1452 previously corrected the bump rules on the documentation page, but the second task from #515 was still open:
Changes
commitizen/cz/conventional_commits/conventional_commits.py— Interactive prompt (cz commit) descriptions now indicate the version bump for each type:refactorandperf: Added "Correlates with PATCH in SemVer"docs,style,test,build,ci: Added "No version bump"commitizen/cz/conventional_commits/conventional_commits_info.txt— Thecz infooutput now explicitly documents thatrefactorandperfcorrelate with PATCH, and clarifies that other types do not trigger a version bump.docs/tutorials/writing_commits.md— The Commit Types section now:refactorandperfalongsidefeatandfixas types that affect semantic versioningdocs,style,test,build,ci,choreas triggering no version bumpfeatandfixaffect versioningChecklist
Documentation Changes
poetry doclocally to ensure the documentation pages renders correctlyCloses #515
This PR was created with the assistance of Claude Opus 4.6 by Anthropic. Happy to make any adjustments!