-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
task: add support for pre-commit, commitizen and commitlint #101
base: main
Are you sure you want to change the base?
Conversation
My experience is that using a tool to generate the changelog from the conventional commits is helpful, but not good to completely automate. It's usually best to start with the generated changelog, then modify it as needed. How does this setup handle the changelog? |
You have to manually generate the changelog with Another bonus with |
Do you have experience in other projects of going with a completely automated changelog? I don't like that |
@cylewitruk can you add a CONTRIBUTING.md to go with this? Or a contributing section could just be added to the end of the README |
Just commenting here that I haven't forgotten this issue, just been tunnel-visioned on the testing tool. Will get around to this eventually :) |
Converted to draft given it's not an immediate need. Can be reopened & merged at a later date. |
Adds support for (optional) tooling along with project-wide configs for the tools.
pre-commit
(https://pre-commit.com/) - this is a tool in python (pip install pre-commit
) which makes distributing/re-using git hooks easy. Justpre-commit install
in the project root and all the configuration will be applied for all of us :)commitlint-rs
(https://lib.rs/crates/commitlint-rs, though I had to make some modifications in a fork to get it working, will PR these changes to their repo) - this tool will lint according to the Conventional Commits rules which are setup in.commitlintrc.yaml
. Trying to commit with an invalid message will reject the commit locally, so you can re-do the commit correctly without needing to rollback/rewrite history :)commitizen
(https://commitizen-tools.github.io/commitizen/) - also in python,pip install commitizen
- tooling which can do things like bump the version, auto-generateCHANGELOG.md
from Conventional Commits, etc. (see the auto-generated changelog in this PR).That reminds me, I should update the readme as well... will do that tomorrow :) Since this repo is small and isolated it could be a decent PoC to evaluate if it would work for some of the other projects.