🧰 git-kit

cli to help format your git commit messages consistently with less effort via pre-provided templates 🤩

text - ⚠️ break Breaking change that could break a consuming application - 🐛 bug Fix that resolves an unintended issue - 📦 deps Dependency update or migration to a new dependency - 📖 docs Documentation change - ✨ feature Adds new functionality - 🧹 refactor Improvement of code / structure without adding new functionality - 🧪 test Adds or improves the existing tests related to the code base

• [TICKET-123] 🐛 fix
• [TICKET-123] 🧹 Clean up

🥽 Prerequisites

• Install Rust

⏳ Install Binary

bash cargo install git-kit

bash git-kit --help

🏎️💨 Getting Started

☑ Templates command

Lists currently available commit templates to add your own checkout Custom Commit templates.

```bash git-kit templates

• bug | Fix that resolves an unintended issue
• ... ```

🎟️ Checkout command

Creates or checks out an existing git branch and adds a ticket number as context against that branch for future commits.

So now you don't have to remember the ticket number associated to the branch! 💡.

When it's time to commit your changes the provided ticket number will be injected into each commit message
thats created on the linked branch for you automatically! 😄

bash git-kit checkout my-branch -t TICKET-123

This will create or checkout a branch named my-branch & link TICKET-123 as the ticket number context to inject on any future commits on the branch named my-branch.

Most likely your ticket / issue will only have one branch associated to it in this case you can use the following shorthand 👌

bash git-kit checkout TICKET-123

This will create or checkout a branch TICKET-123 & link TICKET-123 as the ticket number context to inject on any future commits on the branch TICKET-123.

🔗 Context command

Create or update context linked to the current checked out branch.

This is handy if you forgot to checkout by the provided git-kit checkout command or if you've made a typo in on the provided ticket number.

Again when it's time to commit your changes the provided ticket number will be injected into each commit message
thats created on the linked branch for you automatically!

bash git-kit context TICKET-123

🚀 Commit command

Commits your changes with a formatted message with your ticket number injected if provided from the checkout or the context command.

When committing you can specify a template to use to help describe the changes made within your commit.

text - ⚠️ break Breaking change that could break a consuming application - 🐛 bug Fix that resolves an unintended issue - 📦 deps Dependency update or migration to a new dependency - 📖 docs Documentation change - ✨ feature Adds new functionality - 🧹 refactor Improvement of code / structure without adding new functionality - 🧪 test Adds or improves the existing tests related to the code base

bash git-kit commit bug -m "fix"

This will create an editable commit with the following format and will insert branch name will be injected by default into the bug commit template.

[TICKET-123] 🐛 fix

⚙️ Configuration

You can provide your own templates simply by creating your own configuration file .git-kit.yml, this can be provided to the cli in one of the following ways.

• Provide a config file path via --config option.
• Create a .git-kit.yml config file within your git repositories root directory.
• Use a config file previously added / linked via config add subcommand as highlighted in the persist configuration guide.

Otherwise the default configuration will be used. The default config file can also be customized but it's not recommend as the templates could be replaced on any new releases.

Persist Configuration

Persisting / linking your own config file can be done by providing the file path to your config file and a reference name.

bash git-kit config add $CONFIG_NAME $CONFIG_PATH

You can add multiple config files and switch between them via set command.

bash git-kit config set $CONFIG_NAME

If you wish to return to the default provided templates you can run one of the following commands.

bash git-kit config set default

bash git-kit config reset

🛠 Custom Commit template example

Here's an example of a custom template called 'custom'

yaml commit: templates: custom: description: My custom commit template 🎸 content: | {ticket_num} 🤘 {message}

To ensure your template has been loaded simply run 👇 to see a list of the currently configured templates.

```bash git-kit templates

• custom | My custom commit template 🎸
• ... ```

Then when your ready use it! 🪂

bash git-kit commit custom \ --ticket TICKET-123 \ --message "Dang!"

[TICKET-123] 🤘 Dang!