From ec2f61125fa28fa4a00c034d5d69a9a957c7bb46 Mon Sep 17 00:00:00 2001 From: zontreck Date: Sat, 5 Oct 2024 00:39:25 -0700 Subject: [PATCH] docs(readme): add changelog section to readme Signed-off-by: zontreck --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 8bdb18f..a877431 100644 --- a/README.md +++ b/README.md @@ -18,3 +18,7 @@ Initial Author: (insert email) We utilize Git Commitizen for structuring commits in a way that is compatible with automatically generating changelogs. If you submit a PR without utilizing git cz, you will be asked to resubmit the PR with CZ based commits. https://commitizen-tools.github.io/commitizen/ + +# Changelog + +The changelog is automatically generated by `cz`. To generate a changelog any time, use this command: `cz ch`, however the changelog is automatically generated and committed whenever `cz bump` is run.