Commit Messages

Guidelines for writing clear, concise commit messages that communicate intent at a glance.

When to Use

• Writing a commit message for new changes
• Squashing or rebasing commits
• Reviewing commit messages for clarity

NOT for: tag messages, merge commit messages from automated tools, or changelog entries.

Procedure

1. Write a concise subject line — the first line is what most people see:
   • Soft maximum 160 characters; shorter is better
   • Use imperative mood: "Add feature", not "Added" or "Adds"
   • Capitalize the first letter; no trailing period
   • Summarize the change, not the process