Skip to content

Git Commit

Steve Gibbard edited this page Jul 20, 2024 · 1 revision

Git Commit Notes

Writing Commit Messages

Commit Message Template

Credit: Tim Pope

Capitalized, short (50 chars or less) summary

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
or "Fixes bug."  This convention matches up with commit messages generated
by commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too

- Typically a hyphen or asterisk is used for the bullet, followed by a
  single space, with blank lines in between, but conventions vary here

- Use a hanging indent

If you use an issue tracker, add a reference(s) to them at the bottom,
like so:

Resolves: #123

Commit Summary Prefix

It can also be useful to prefix the summary or title of the commit with the type of fix.

feat: The new feature you're adding to a particular application
fix: A bug fix
style: Feature and updates related to styling
refactor: Refactoring a specific section of the codebase
test: Everything related to testing
docs: Everything related to documentation
chore: Regular code maintenance

Basic Commit with Message

git commit -m "feat: My new enhancement" . 

### Update Commit Message

To update the latest commit message:

git commit --amend

If the commit has already been pushed then you need force push the commit update:

git push --force origin <branch>

Clone this wiki locally