Best Practices for Commit Messages: A Guide for Computer Scientists

Introduction

As a computer scientist, you're probably familiar with the pain of writing a commit message that's just a list of changes without any context or explanation. Don't be that person. Follow these best practices to make your commit messages shine like a well-crafted science experiment gone right!

The Golden Rules

Rule 1: Be Concise

Avoid using 3 words where 1 will do
Use short paragraphs, not novels

Rule 2: Be Descriptive

Explain why you're making the changes, not just what changes you're making
Use imperative mood, not passive voice (we fixed, not we were fixed)

Rule 3: Be Consistent

Use a consistent tone and style throughout
Avoid jargon and technical terms that nobody else understands

Subpage: The Art of Verbosity

Learn the ancient art of writing the perfect commit message in 7 words or less: Seven Word Wonders

Subpage: A Guide to Commit Message Length

Discover the secret to commit messages that are just long enough to be clear, but not so long they put the reader to sleep: Commit Message Length

Subpage: The Commit Message Style Guide

Learn to write commit messages that are both clear and concise, without resorting to the dark side: Commit Message Style Guide