Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make commit messages "imperative" #892

Merged
merged 2 commits into from
May 1, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion source/standards/source-code/working-with-git.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,17 @@ ticket is publicly viewable (and likely to remain so).
Commit messages should start with a one-line summary no longer than 50
characters. Various Git tools (including GitHub) use this as the commit
summary, so you should format it like an email subject, with a leading capital
and no full stop. The Git convention is to write these in the present tense.
and no full stop. The Git convention is to write these in the imperative mood,
as if you are issuing a command to the repository.

For example:

> Leverage best-of-breed synergies going forward

It can help to imagine a silent "please" at the beginning of your message:

> [Please] Leverage best-of-breed synergies going forward

You should leave a blank line before the rest of the commit message, which you
should wrap at around 72 characters: this makes it easier to view commit
messages in a terminal.
Expand Down