Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit bb61b44

Browse files
docs(BumpRule): adjust docstring
1 parent 650c720 commit bb61b44

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

‎commitizen/bump_rule.py

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,20 +100,18 @@ def extract_increment(
100100
"""Determine the version increment based on a commit message.
101101
102102
This method analyzes a commit message to determine what kind of version increment
103-
is needed according to the Conventional Commits specification. It handles special
104-
cases for breaking changes and respects the major_version_zero flag.
103+
is needed. It handles special cases for breaking changes and respects the major_version_zero flag.
104+
105+
See the following subclasses for more details:
106+
- ConventionalCommitBumpRule: For conventional commits
107+
- CustomBumpRule: For custom bump rules
105108
106109
Args:
107-
commit_message: The commit message to analyze. Should follow conventional commit format.
108-
major_version_zero: If True, breaking changes will result in a MINOR version bump
109-
instead of MAJOR. This is useful for projects in 0.x.x versions.
110+
commit_message: The commit message to analyze.
111+
major_version_zero: If True, breaking changes will result in a MINOR version bump instead of MAJOR
110112
111113
Returns:
112114
VersionIncrement: The type of version increment needed:
113-
- NONE: For commits that don't require a version bump (docs, style, etc.)
114-
- MAJOR: For breaking changes when major_version_zero is False
115-
- MINOR: For breaking changes when major_version_zero is True, or for new features
116-
- PATCH: For bug fixes, performance improvements, or refactors
117115
"""
118116

119117

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /