Skip to content

Commit 9818c7d

Browse files
committed
docs(init): re-write section
1 parent 3ca7ec1 commit 9818c7d

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

docs/init.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
1-
For new projects, it is possible to run `cz init`.
1+
To start using commitizen, the recommended approach is to run
22

3-
This command will prompt the user for information about the project and will
4-
configure the selected file type (`pyproject.toml`, `.cz.toml`, etc.).
5-
6-
This will help you quickly set up your project with `commitizen`.
3+
```sh
4+
cz init
5+
```
76

8-
Currently `init` is detecting
7+
This command will ask you for information about the project and will
8+
configure the selected file type (`pyproject.toml`, `.cz.toml`, etc.).
99

10-
1. Commit convention rules (`name`).
11-
2. Version detection based on the existing tags (`version`).
12-
3. Tag format, if your tag convention uses, for example `v*` in front of the version. (`tag_format`)
10+
The `init` will help you with
1311

14-
We hope to detect the files where the version is also repeated eventually,
15-
like `package.json` or `__version__`.
12+
1. Choose a convention rules (`name`)
13+
1. Choosing a version provider (`commitizen` or for example `Cargo.toml`)
14+
1. Detecting your project's version
15+
1. Detecting the tag format used
16+
1. Choosing a version type (`semver` or `pep440`)
17+
1. Whether to create the changelog automatically or not during bump
18+
1. Whether you want to keep the major as zero while building alpha software.

0 commit comments

Comments
 (0)