diff options
| author | Gergely Nagy <gergely.nagy@arm.com> | 2023-12-13 19:07:28 +0000 |
|---|---|---|
| committer | Gergely Nagy <gergely.nagy@arm.com> | 2024-01-23 12:53:01 +0000 |
| commit | 732d8ef0bba9d23c731611dbed25e2e24a8a30d2 (patch) | |
| tree | f369a01301e8a4634e232a9b0c21854e22f63b69 /CONTRIBUTING.md | |
| parent | 54eec806272b7574a0757c77a913a369a9ecdc70 (diff) | |
| download | mlia-732d8ef0bba9d23c731611dbed25e2e24a8a30d2.tar.gz | |
build: Integrate Commitizen to check commit messages and generate changelog
The commit messages are checked against the Conventional Commits
(https://www.conventionalcommits.org) specification, along with minor
customizations (eg, capitalized header, some irrelevant commit types removed
Checking messages is integrated into `tox -e lint`.
Changelog generation is integrated into "tox -e changelog", which runs
`cz changelog` command underneath and incrementally updates RELEASES.md.
Change-Id: I86f21f6c78a166d3bb92450a027a2d7e71ce22cf
Signed-off-by: Gergely Nagy <gergely.nagy@arm.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df12003..de70378 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,10 @@ Below is an overview on contributing code to MLIA. git commit -s ``` +- For the commit messages, the codebase follows [Conventional Commits](https://www.conventionalcommits.org), + with some customizations. Header description is be capitalized, and the following + commit types are allowed: build, ci, docs, feat, fix, perf, refactor, style, test. + - Push patch for code review ```bash |