Skip to content

Commit 51640fd

Browse files
committed
docs: prepare readme for v3
1 parent d5abc43 commit 51640fd

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

docs/README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,26 @@
1717

1818
## About
1919

20-
Commitizen is a tool designed for teams.
20+
Commitizen is release management tool designed for teams.
2121

22-
Its main purpose is to define a standard way of committing rules
23-
and communicating it (using the cli provided by commitizen).
22+
Commitizen assumes your team uses a standard way of commiting rules
23+
and from that foundation, it can bump your project's version, create
24+
the changelog, and update files.
2425

25-
The reasoning behind it is that it is easier to read, and enforces writing
26-
descriptive commits.
26+
By default, commitizen uses [conventional commits][conventional_commits], but you
27+
can build your own set of rules, using different rules.
2728

28-
Besides that, having a convention on your commits makes it possible to
29-
parse them and use them for something else, like generating automatically
30-
the version or a changelog.
29+
Using a standarized set of rules to write commits makes commits easier to read, and enforces writing
30+
descriptive commits.
3131

32-
### Commitizen features
32+
### Features
3333

3434
- Command-line utility to create commits with your rules. Defaults: [Conventional commits][conventional_commits]
35-
- Display information about your commit rules (commands: schema, example, info)
3635
- Bump version automatically using [semantic versioning][semver] based on the commits. [Read More](./bump.md)
3736
- Generate a changelog using [Keep a changelog][keepchangelog]
37+
- Update your project's version files automatically
38+
- Display information about your commit rules (commands: schema, example, info)
39+
- Create your own set of rules and publish them to pip. Read more on [Customization](./customization.md)
3840

3941
## Requirements
4042

@@ -44,10 +46,10 @@ Python 3.7+
4446

4547
## Installation
4648

47-
Global installation
49+
To make commitizen available in your system
4850

4951
```bash
50-
sudo pip3 install -U Commitizen
52+
pip install --user -U Commitizen
5153
```
5254

5355
### Python project
@@ -72,7 +74,7 @@ poetry add commitizen --dev
7274

7375
### macOS
7476

75-
On macOS, it can also be installed via [homebrew](https://formulae.brew.sh/formula/commitizen):
77+
via [homebrew](https://formulae.brew.sh/formula/commitizen):
7678

7779
```bash
7880
brew install commitizen
@@ -108,7 +110,7 @@ or the shortcut
108110
cz commit -s
109111
```
110112

111-
### Integrating with Pre-commit
113+
### Integration with Pre-commit
112114

113115
Commitizen can lint your commit message for you with `cz check`.
114116

docs/customization.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,9 @@ You can also automate the steps above through [cookiecutter](https://cookiecutte
201201
cookiecutter gh:commitizen-tools/commitizen_cz_template
202202
```
203203

204-
See [commitizen_cz_template](https://github.com/commitizen-tools/commitizen_cz_template) for detail.
204+
See [commitizen_cz_template](https://github.com/commitizen-tools/commitizen_cz_template) for details.
205+
206+
Once you publish your rules, you can send us a PR to the [Third-party section](./third-party-commitizen.md).
205207

206208
### Custom commit rules
207209

0 commit comments

Comments
 (0)