You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+17-8
Original file line number
Diff line number
Diff line change
@@ -18,17 +18,26 @@
18
18
19
19
## About
20
20
21
-
Commitizen is a release management tool designed for teams.
21
+
Commitizen is a powerful release management tool that helps teams maintain consistent and meaningful commit messages while automating version management.
22
22
23
-
Commitizen assumes your team uses a standard way of committing rules
24
-
and from that foundation, it can bump your project's version, create
25
-
the changelog, and update files.
23
+
### What Commitizen Does
26
24
27
-
By default, commitizen uses [conventional commits][conventional_commits], but you
28
-
can build your own set of rules and publish them.
25
+
By enforcing standardized commit conventions (defaulting to [Conventional Commits][conventional_commits]), Commitizen helps teams:
29
26
30
-
Using a standardized set of rules to write commits makes commits easier to read and enforces writing
31
-
descriptive commits.
27
+
- Write clear, structured commit messages
28
+
- Automatically manage version numbers using semantic versioning
29
+
- Generate and maintain changelogs
30
+
- Streamline the release process
31
+
32
+
### Key Benefits
33
+
34
+
With just a simple `cz bump` command, Commitizen handles:
35
+
36
+
1.**Version Management**: Automatically bumps version numbers and updates version files based on your commit history
37
+
2.**Changelog Generation**: Creates and updates changelogs following the [Keep a changelog][keepchangelog] format
38
+
3.**Commit Standardization**: Enforces consistent commit message formats across your team
39
+
40
+
This standardization makes your commit history more readable and meaningful, while the automation reduces manual work and potential errors in the release process.
0 commit comments