scratch-sb1-converter/README.md
Christopher Willis-Ford 61780f3d5d docs: add description to README.md
BREAKING CHANGE: trying again to bump this to v1.x
2024-02-21 12:35:05 -08:00

20 lines
772 B
Markdown

# scratch-sb1-converter
Scratch 1 (.sb) to Scratch 2 (.sb2) conversion library for Scratch 3.0
## Committing
This project uses [semantic release](https://github.com/semantic-release/semantic-release) to ensure version bumps
follow semver so that projects depending on it don't break unexpectedly.
In order to automatically determine version updates, semantic release expects commit messages to follow the
[conventional-changelog](https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md)
specification.
You can use the [commitizen CLI](https://github.com/commitizen/cz-cli) to make commits formatted in this way:
```bash
npm install -g commitizen@latest cz-conventional-changelog@latest
```
Now you're ready to make commits using `git cz`.