Skip to main content

Revert Template

Builds on the message that git revert generates and adds the part Git can't know: why the change is being undone and what that means for users and follow-up work.

When to use it
  • You are undoing a commit that has already been shared.
  • A deploy needs to be rolled back quickly.
  • You want the reason for the rollback to stay with the history.

Template

Download

Replace each <placeholder> by hand when you write a commit.
Lines starting with # are guidance that Git removes in its default cleanup mode.

Completed example

Rolling back an infrastructure change.

Revert "Enable HTTP/2 for asset requests"

This reverts commit 3f9c1b2e8a4d6f0c7b5e9a1d2c3f4e5a6b7c8d9e.

Reason:
Some corporate proxies downgrade connections mid-request, which led
to truncated stylesheet responses for customers behind them.

Consequences:
Assets are served over HTTP/1.1 again. Re-enabling HTTP/2 is tracked
in WEB-381 and depends on a fallback for the affected proxies.

Guidance

Rules

  • Keep Git's generated subject and "This reverts commit …" line so tools can link the two commits.
  • Explain the reason for the revert; Git cannot generate that part.
  • Mention the behavior that returns and any follow-up.

Optional fields

Consequences
Can be brief for a simple rollback, but mention anything users will notice.

Common mistakes

  • Reverting with only the generated message and no reason.
  • Shortening the commit hash in the "This reverts commit" line.
  • Reverting several unrelated commits in one commit without listing them.

How it relates to other templates

With Conventional Commits, the specification's FAQ suggests a revert: type and a Refs: footer listing the reverted commit hashes instead of Git's default subject.

Use this template

Use in Tower

Tower for Mac

  1. Open Tower's Settings and select the Templates tab.
  2. Create a new template and enter the subject and body below. You can also download the template file and import it from the same tab. After importing, remove the lines that start with #. They're guidance for Git's editor.
  3. To use it by default, set it as the global Git value in the Templates tab, or pick it as the default commit template in a repository's settings.
  4. When you write a commit, click the Commit template button below the description field, or type t: or / in the subject field to choose a template.
Inserting a commit template while composing a commit in Tower for Mac.

More details: Commit Templates in the Tower for Mac documentation.

Tower for Windows

  1. Open Tower's Preferences and select the Templates tab.
  2. Click + to create a new template and enter the subject and body below.
  3. To use it by default, set it as the global default template, or pick it as the default in a repository's settings.
  4. When you write a commit, click the Commit template button in the commit composer, or type t: or / in the subject field to choose a template.
The Commit template button and template list in Tower for Windows' commit composer
Choosing a commit template in Tower for Windows.

More details: Commit Templates in Tower for Windows.

Template fields for Tower

The library version with Git's # comment lines removed. If you edited the template above, copy your version from the editor instead.

Subject

Revert "<subject of the reverted commit>"

Body

This reverts commit <full hash of the reverted commit>.

Reason:
<Why the change is being undone>

Consequences:
<What behavior returns, and any follow-up that is planned>

Use with the Git command line

Download gitmessage-revert.txt

The commands below assume the file is in your Downloads folder.

macOS and Linux (Terminal)

Try it once

Run this in a repository with staged changes. Git opens your editor with the template filled in:

git commit --template ~/Downloads/gitmessage-revert.txt

Make it the default for one repository

From the repository's root folder, save the file as .gitmessage and point Git to it:

mv ~/Downloads/gitmessage-revert.txt .gitmessage
git config commit.template .gitmessage

Make it your global default

Save the file in your home folder and use it for every repository without its own setting:

mv ~/Downloads/gitmessage-revert.txt ~/.gitmessage
git config --global commit.template "~/.gitmessage"

Windows (PowerShell)

Try it once

Run this in a repository with staged changes. Git opens your editor with the template filled in:

git commit --template "$HOME\Downloads\gitmessage-revert.txt"

Make it the default for one repository

From the repository's root folder, save the file as .gitmessage and point Git to it:

Move-Item "$HOME\Downloads\gitmessage-revert.txt" .gitmessage
git config commit.template .gitmessage

Make it your global default

Save the file in your home folder and use it for every repository without its own setting:

Move-Item "$HOME\Downloads\gitmessage-revert.txt" "$HOME\.gitmessage"
git config --global commit.template "~/.gitmessage"

Share it with your team

Commit .gitmessage to the repository so everyone has the same file. Sharing the file does not configure anyone's Git: Git never applies settings from a repository automatically, so each teammate runs this once in their clone:

git config commit.template .gitmessage

Inspect, change, or remove the default

# Show the configured template and where it's set
git config --show-origin --get commit.template

# Point to a different file
git config commit.template path/to/other-template.txt

# Remove the repository or global setting
git config --unset commit.template
git config --global --unset commit.template
Good to know
  • Templates guide, hooks enforce. A template only pre-fills the editor. To reject messages that don't follow a convention, add a commit-msg hook.
  • Only the editor uses templates. git commit -m and git commit -F bypass the template.
  • Unchanged templates abort the commit. If you save without editing the template, Git stops with "you did not edit the message".
  • Comment removal depends on cleanup. Git strips # lines under its default strip cleanup mode. With --cleanup=verbatim, --cleanup=whitespace, or a matching commit.cleanup setting, they stay in the message. If you changed core.commentChar, # lines aren't treated as comments.
  • Other commands write their own messages. git revert and git merge don't load commit.template.

Setting up Git from scratch? The Git Config Generator builds a complete .gitconfig for you. See the git commit documentation for all options.

Use with coding agents

This skill teaches your coding agent to draft commit messages in the Revert format. It uses the library version of the template. Edits you make in the editor above aren't included.

  • Follows your repository's instructions and your explicit requests first.
  • Reads the staged changes and keeps unstaged work out of the message.
  • Never invents motivation, issue numbers, benchmarks, or test results. It leaves placeholders and asks instead.
  • Flags breaking changes and unrelated changes that should be split.
  • Drafts only. It won't stage, commit, or push unless you ask it to.

Download skill commit-message-revert-v1.0.0.zip · Agent Skills format · MIT-0 license

Contains commit-message-revert/SKILL.md with the instructions, references/REFERENCE.md with the rules and a completed example, and assets/template.txt.

Install in Claude Code

  1. Unzip the download. It contains a single folder named after the skill.
  2. Move that folder to .claude/skills/ in your repository to share it with your team, or to ~/.claude/skills/ to use it in all your projects.
  3. Start a new Claude Code session and ask it to draft a commit message. You can also invoke the skill directly with /commit-message-revert.

See the Claude Code skills documentation for details.

Other agents

The package uses the open Agent Skills format, but we've only tested the agents listed above. For any other agent, check its documentation for skill support, or add the instructions below to its configuration file, such as AGENTS.md.

Copy the instructions

Add these instructions to your agent's configuration or your repository's AGENTS.md:

## Commit messages

Use the Revert structure below.

```text
Revert "<subject of the reverted commit>"

This reverts commit <full hash of the reverted commit>.

Reason:
<Why the change is being undone>

Consequences:
<What behavior returns, and any follow-up that is planned>
```

Rules:
- Keep Git's generated subject and "This reverts commit …" line so tools can link the two commits.
- Explain the reason for the revert; Git cannot generate that part.
- Mention the behavior that returns and any follow-up.
- Take the reverted commit's subject and full hash from git log or git show, never from memory.
- Only state a reason for the revert that the user gave or that is documented. Otherwise leave the placeholder and ask.

When writing a commit message:
- Base it on the staged changes (`git diff --staged`). Don't describe unstaged work as part of the commit.
- If the staged changes are unrelated to each other, suggest splitting the commit.
- Never invent motivation, issue identifiers, benchmark numbers, or test results. Keep a `<placeholder>` and ask instead.
- Call out breaking changes and include migration information supported by the changes.
- Draft the message for review. Don't stage, commit, or push unless explicitly asked.
← All commit templates