This script is designed to help you create structured and consistent commit messages.
When you run the script, it will ask you a series of questions:
- What type is it? (Options: feat, fix, docs, chore, style, refactor, test, perf, ci, build)
- In which scope? (Example: auth, api, db...)
- A description of the commit.
- Are there any breaking changes? (y/n)
- A body for the commit message.
- Are there any issues/PR closed by this commit? (y/n)
Based on your answers, the script will create a commit message that follows a structured format.
To use the script, simply run it in your terminal:
./script.sh
Please note that you may need to make the script executable first:
chmod +x script.sh
Currently, you have to run the script in the same directory as the script itself. I'm working on a solution to make it more flexible.
Maybe something like Homebrew's brew
command, where you can run it from anywhere.