diff options
| author | Christian Heusel <christian@heusel.eu> | 2023-07-22 10:40:34 +0200 |
|---|---|---|
| committer | Levente Polyak <anthraxx@archlinux.org> | 2023-09-26 21:13:08 +0200 |
| commit | 7e41adf00bb93cf6e016b9a7cd8ebdc693666077 (patch) | |
| tree | c74dde843b40c7fced14a59a1812ca0e544b7e3e /README.md | |
| parent | a316b50f88c9269c5fe54ab6854a7f591c0378dd (diff) | |
| download | devtools-7e41adf00bb93cf6e016b9a7cd8ebdc693666077.tar.xz | |
chore: add a config file for git cliff
This is done so that the generated changelog carries more information
(i.e. the scope of the change).
Co-Authored-by: Levente Polyak <anthraxx@archlinux.org>
Signed-off-by: Christian Heusel <christian@heusel.eu>
Signed-off-by: Levente Polyak <anthraxx@archlinux.org>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
@@ -23,6 +23,34 @@ will automatically build the project and proxy all calls to the local build dire ./test/bin/pkgctl --help ``` +### Commit messages + +All commits must follow [conventional commits](https://www.conventionalcommits.org). + +The following groups are allowed: + +- chore +- feat +- fix +- doc +- perf +- test + +To override the scope for the changelog entry use the `Component:` trailer. + +Example: + +``` +feat(db): yay mega cool feature + +Very long and useful description. + +Fixes #1 +Fixes #2 + +Component: pkgctl db remove +``` + ## Releasing 1. bump the version in the Makefile |