Skip to content

Commit bb56944

Browse files
committed
docs(README.md): make it easier for readers to understand what Commitizen does
1 parent f8b4901 commit bb56944

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

docs/README.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,26 @@
1818

1919
## About
2020

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.
2222

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
2624

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:
2926

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.
3241

3342
### Features
3443

0 commit comments

Comments
 (0)