Skip to content

Commit

Permalink
docs: info about commitizen tool for version control
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jan 18, 2024
1 parent 95c3298 commit 50960b5
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions docs/dev-guide/version-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,31 @@ automatically determined based on the commit types.

## Tools

Some tools can make your life easier when working with conventional commits
and SemVer.
Some tools can make your life easier when working with conventional
commits and SemVer.

### Commitizen

- Versions are managed by Commitizen from the `pyproject.toml` file in a repo.

- Versions are determined by conventional commit messages:
- `fix: xxx` denotes a patch, `feat: xxx` denotes a minor increment.
- Breaking changes are applied every year to increment the `YYYY` in place
of `MAJOR`.

#### Bumping Versions

Install commitizen:

```bash
pip install commitizen
```

Bump the version:

```bash
# cd to the directory containing the pyproject.toml
cz bump --check-consistency --changelog
git push
git push --tag
```

0 comments on commit 50960b5

Please sign in to comment.