diff --git a/.cz.toml b/.cz.toml new file mode 100644 index 0000000..db8c69b --- /dev/null +++ b/.cz.toml @@ -0,0 +1,7 @@ +[tool.commitizen] +name = "cz_conventional_commits" +tag_format = "v$version" +version_scheme = "semver" +version_provider = "cargo" +update_changelog_on_bump = true +major_version_zero = true diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..a66fe3a --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,8 @@ +repos: +- hooks: + - id: commitizen + - id: commitizen-branch + stages: + - pre-push + repo: https://github.com/commitizen-tools/commitizen + rev: v3.30.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d015793..a40d394 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # Contributing Contributors are very welcome! **No contribution is too small and all contributions are valued.** +## Rust You'll need to have the stable Rust toolchain installed in order to develop Managarr. The Rust toolchain (stable) can be installed via rustup using the following command: @@ -11,6 +12,37 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh This will install `rustup`, `rustc` and `cargo`. For more information, refer to the [official Rust installation documentation](https://www.rust-lang.org/tools/install). +## Commitizen +[Commitizen](https://github.com/commitizen-tools/commitizen?tab=readme-ov-file) is a nifty tool that helps us write better commit messages. It ensures that our +commits have a consistent style and makes it easier to generate CHANGELOGS. Additionally, +Commitizen is used to run pre-commit checks to enforce style constraints. + +To install `commitizen` and the `pre-commit` prerequisite, run the following command: + +```shell +python3 -m pip install commitizen pre-commit +``` + +### Commitizen Quick Guide +To see an example commit to get an idea for the Commitizen style, run: + +```shell +cz example +``` + +To see the allowed types of commits and their descriptions, run: + +```shell +cz info +``` + +If you'd like to create a commit using Commitizen with an interactive prompt to help you get +comfortable with the style, use: + +```shell +cz commit +``` + ## Setup workspace 1. Clone this repo diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..4492723 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "managarr", + "lockfileVersion": 3, + "requires": true, + "packages": {} +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..0967ef4 --- /dev/null +++ b/package.json @@ -0,0 +1 @@ +{}