What is resin?
resin is a CLI (command-line interface) tool that makes it easy to create commit messages that follow the conventional commit format. Here is a little demo:
This demo will create the following commit message:
feat(config): add crates.io fields
resin has three flags:
- --help (-h) -> display a help message to the terminal
- --all (-a) -> run
git add .before committing the changes
- --push (-p) -> run
git pushafter committing the changes
Super simple and easy to use!
You can configure resin to have your custom scopes. Below is an example config:
scopes = ['docker', 'github actions']
You can also have a sign-off message that is based off the contents of your
sign = true
This will create a message that will automatically be added to the bottom of your commit message:
Signed-off-by: Matthew Gleich
This file can be stored in
~/.config/resin/config.toml or on a per-project basis by putting it at the root of the project with the same name. You can see a demo of this for this project
You can install resin using cargo:
cargo install resin
We would love to have you contribute! Please read the contributing guide before submitting a pull request. Thank you in advance!