Secret ingredients to quality software

GitHub Repos - Do you write nice commit messages?

Last updated by Piers Sinclair [SSW] on 03 Nov 2021 10:47 pm (3 months ago) See History

Reading ugly commits is not very pleasant and makes it very confusing when you have to check the commit history.

2020 09 17 17 19 04
Bad Example: The commits have no meaning

Ways to improve your commit log:

Tip #1: Have a nice, concise comment

Examples:

  • "Fixed bug with emoji engine"
  • "Added new emoji filter"
  • "Updated Architecture Diagram to have emojis"

Tip #2: Using prefixes

Even better is to add a helpful prefix to categorize your commits.

Examples:

  • "Fix: Fixed bug with emoji engine"
  • "Feature: Added new emoji filter"
  • "Doc: Updated Architecture Diagram to have emojis"

Tip #3: Using emojis 💄

In a text message, emojis helps to add emotion and context to plain text. Why not use them in commit messages too 😃?

Examples:

  • "🐛 Fixed emoji engine in language component"
  • "🚀 Added emoji filter on Snapchat"
  • "📄 Added emoji’s to changelog"

There are a bunch more options to choose from - carloscuesta/gitmoji: An emoji guide for your commit messages. 😜 (github.com)

Tip #4: Using gitmoji VSCode extension

Gitmoji - Visual Studio Marketplace (visualstudio.com).

You can even go 🤘 hardcore and use the gitmoji cli - carloscuesta/gitmoji-cli: A gitmoji interactive command line tool for using emojis on commits. 💻 (github.com)

commits with emojis
Good Example: Great use of emoji and concise message

See what emojis work best with each topic here: https://gitmoji.dev/

emojis list
Figure: Emojis list

Adam CoganAdam Cogan
Matt WicksMatt Wicks
Tiago AraujoTiago Araujo

We open source. Powered by GitHub