DEV Community

Cover image for Level Up Your Git Commits with Custom Templates 👇🏻
Alberto Barrago
Alberto Barrago

Posted on

Level Up Your Git Commits with Custom Templates 👇🏻

#git #github #gitlab #devops

As developers, we commit code constantly. A clean, descriptive Git commit history isn't just good practice; it's a lifeline for collaboration, debugging, and understanding project evolution. But let's be honest, crafting perfect commit messages every time can feel like a chore. This is where custom Git commit message templates become your secret weapon.

Why Templates are a Git Superpower

Imagine instantly knowing what each commit does, just by glancing at its subject. That's the power of consistency. Templates help you:

  • Enforce Standards: Ensure every commit adheres to a defined structure (like Conventional Commits or Gitmoji).
  • Boost Readability: Make your git log a joy to read, not a cryptic puzzle.
  • Improve Automation: Standardized messages can fuel changelog generation, release tooling, and more.
  • Save Time: Eliminate the blank slate dilemma. Your structure is ready; just fill in the details.

Step by Step Guide

  • Step 1: Create Your Commit Message Template File First, you need a text file containing your desired commit message structure. You can put this anywhere on your system, but your home directory is a common choice (e.g., ~/.git_commit_template.txt).

Here's an example template, inspired by common conventions, that you can adapt:

# -----------------------------------------------------------
# Git Commit Message Template
#
# Adopted from Conventional Commits & Gitmoji for clarity.
#
# Format: <type>(<scope>): <subject>
#
# Body: Detailed explanation (wrap at 72 chars)
#
# Footer: Breaking Changes, Issue References (e.g., Closes #123)
# -----------------------------------------------------------

<type>(<scope>): <subject>

# Example Commit Types (choose one, and add your preferred emoji):
# ✨ feat: Introduces a new feature.
# 🐛 fix: Patches a bug.
# 📚 docs: Documentation-only changes.
# 🎨 style: Code formatting, whitespace, or semi-colons (no code logic change).
# ♻️ refactor: Code restructure that neither fixes a bug nor adds a feature.
# ⚡️ perf: Improves performance.
# 🧪 test: Adds or corrects tests.
# 👷 ci: Changes to CI configuration files and scripts.
# 🚀 deploy: Deployment-related changes.
# 📦️ build: Changes that affect the build system or external dependencies.
# 💥 breaking: Introduces a breaking API change (add to footer).
# ⏪️ revert: Reverts a previous commit.
# 🗑️ chore: Other changes that don't modify src or test files.

# Scope (optional): The part of the codebase affected (e.g., 'auth', 'ui', 'api').

# Subject (required): Concise, imperative mood (e.g., "add", "fix", "update"). Max 50 chars.

# Body (optional):
# Provide a more detailed explanation of the change.
# Explain *what* was changed and *why* it was changed, not *how*.
# Wrap lines at approximately 72 characters for readability in `git log`.

# Footer (optional):
# Add references to issues: Closes #ISSUE-ID, Fixes #BUG-ID.
# Detail breaking changes: BREAKING CHANGE: Explains the breaking API change.
# Co-authored-by: Another Dev <[email protected]>
Enter fullscreen mode Exit fullscreen mode

Save this content to a file named ~/.git_commit_template.txt (or a similar path).

  • Step 2: Configure Git to Use Your Template Now, tell Git to use this file for all your commit messages. Open your terminal and run: 
git config --global commit.template ~/.git_commit_template.txt
Enter fullscreen mode Exit fullscreen mode

If you prefer to use it only for a specific repository, navigate to that repo's directory and omit --global:

git config commit.template ./.git_commit_template.txt
Enter fullscreen mode Exit fullscreen mode
  • Step 3: Commit Like a Pro! The next time you type git commit (without the -m flag), your default text editor (e.g., Vim, Nano, VS Code) will open, pre-populated with your template's content. 
git commit
Enter fullscreen mode Exit fullscreen mode

Key Usage:

Lines starting with # are comments and Git will ignore them.
Fill in your actual commit message on the first line (or subsequent lines for the body).
Delete or ignore the commented sections of the template.
Save and close the editor, and Git will create your commit!
For instance, you might fill it out like this:

✨ feat(api): Add user profile endpoint

This commit introduces a new /api/users/{id} endpoint
that returns detailed user profile information,
including their public posts and a sanitized email.

Closes #789
Enter fullscreen mode Exit fullscreen mode

Pro Tips for Template Mastery

Editor Configuration: Ensure your Git editor is set to one you're comfortable with. You can configure it globally:

git config --global core.editor "code --wait" # For VS Code
git config --global core.editor "nano"       # For Nano
Enter fullscreen mode Exit fullscreen mode
  • Emoji Support: The emojis will render correctly in most modern terminals, Git clients, and platforms like GitHub, GitLab, and Bitbucket.
  • The -m Flag: Remember, using git commit -m "Your message" will bypass the template. The template is only used when Git opens an editor for the commit message.
  • Continuous Improvement: Your template isn't set in stone! As your team's needs or your personal preferences evolve, update your template file to reflect those changes.

Implementing a commit message template is a small change with a big impact on your Git history's clarity and maintainability. Give it a try, and you'll wonder how you ever managed without it!

What commit message conventions do you find most useful?
Share your thoughts below!

ps: Gift for zsh users: Here

Top comments (0)