From ccc9094c0311ba5606ae5b44e5fe9a11bc4ba72d Mon Sep 17 00:00:00 2001 From: Megan Warres Date: Tue, 12 Sep 2023 12:58:12 -0700 Subject: [PATCH] docs(README): Document enabling automated bumps Add documentation for enabling automated version bumps via Commitizen as one of the steps in the README. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0a5831f..9355159 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,8 @@ GitHub Template Repository for ScribeMD particular tools to ignore particular files if they do not read from [`.gitignore`](.gitignore) or [do so incorrectly](https://github.com/kucherenko/jscpd/issues/466). + - [ ] [If you wish to enable automatic version bumps through Commitizen](https://commitizen-tools.github.io/commitizen/bump/), + remove `bump: false` in [`.github/workflows/test.yaml`](.github/workflows/test.yaml). - [ ] Add any needed development tools with an [available asdf plugin](https://github.com/asdf-vm/asdf-plugins) to [`.tool-versions`](.tool-versions).