Mastering Git Commit Messages: Secrets, Tips, and Tricks (with examples)

Work with Your History in Git Unit | Salesforce Trailhead

In the world of version control, effective communication is vital. Your commit messages are the bridge between you, your team, and your future self. Crafted with care, they can enhance collaboration, code comprehension, and project history.

Let’s dive into the secrets, tips, and tricks to elevate your “git commit” game.

Keep It Short and Sweet

A commit message should be concise yet informative.

Tip: Limit the first line to 50 characters and provide additional context in the body.

Bad: "Fixed a bug"
Good: "Fix issue with user registration"

Write in the Imperative Mood

Frame your commit messages as commands.

Tip: Start with a verb that indicates what the commit does.

Bad: "Fixing bug in the login page"
Good: "Fix bug in the login page"

Focus on What and Why

Explain what the commit changes and why it’s necessary.

Tip: Provide context on the problem and the solution.

Bad: "Added new feature"
Good: "Add user profile picture upload to enhance personalization"