From 8ac9ed2331d896b572d46c0153406ebadcb832f0 Mon Sep 17 00:00:00 2001 From: Yosef Bedaso Date: Tue, 1 Jul 2025 12:47:04 -0700 Subject: [PATCH] docs: adds note for version bumps BREAKING CHANGE: a commit to set the version to v.1.0.0 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d8af705..3002f50 100644 --- a/README.md +++ b/README.md @@ -127,6 +127,8 @@ The table below, from [semantic release](https://github.com/semantic-release/sem | `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release | | `perf(pencil): remove graphiteWidth option`

`BREAKING CHANGE: The graphiteWidth option has been removed.`
`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release
(Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) | +Note: The automatic version bump workflow does not work for manual version changes. As shown above, use the appropriate `scope` and commit message that reflects changes included in a PR. + ### Documentation To generate the rst files source files for documentation, run ```bash