CONTRIBUTING.md 1.31 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
### Tests

- clone this repository
- `pip install -e ".[dev]"`

### Pre-commit

---

To enforce most required guidelines, please use the precommit mechanism.
This will perform some automatic checks before committing.

To use it, you need the `pre-commit` Python
you can then install hooks with:

```shell script
pre-commit install
pre-commit install --hook-type commit-msg
```

Then, you will be able to notice the automatic checks when running `git commit`.

To run pre-commit on all files:

```shell script
cz changelog --incremental
```

## Commit and Changelog

This software do use commitizen. So you should make valid commit message.
to do so, we recommand you to type :

```shell script
cz commit --dry-run > .current_commit_message
git commit -eF .current_commit_message
```

you can also use cz check : see https://commitizen-tools.github.io/commitizen/check/

41 42
## create new version

43 44 45
To update the changelog:

```shell script
46
cz changelog --incremental --unreleased-version {new_version}
47
```
48

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
You can then add some manual change to changelog
commit the changelog commit as a bump commit:

```shell script
git commit -m "docs(CHANGELOG): Update changelog for version {new_version}"
```

Tag the new_version:

```shell script
git tag {new_version}
```

push the tag to master:

```shell script
git push origin master {new_version}
```