Skip to content

Commit Messages

Jump to bottom Edit New page
Margen67 edited this page Apr 20, 2021 · 8 revisions

Commit Messages

Please follow this guide to write commit messages consistently and correctly.

Model message format:

Capitalised, short (50 chars or less) summary

More detailed explanatory text, if necessary.  Wrap it to about 72
characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank
line separating the summary from the body is critical (unless you omit
the body entirely); tools like rebase can get confused if you run the
two together.

Write your commit message in the present tense: "Fix bug" and not "Fixed
bug."  This convention matches up with commit messages generated by
commands like git merge and git revert.

Further paragraphs come after blank lines.

- Bullet points are okay, too

- Typically a hyphen or asterisk is used for the bullet, preceded by a
  single space, with blank lines in between, but conventions vary here

- Use a hanging indent

Bug Fix: Remember that each commit has to be understandable on its own, without having to cross-reference GitHub.

A commit message like Fix #1234 is not acceptable.

Fix #3107: Number of sold items is reset after some time

Number of sold items was being overwritten by a memmove on the field
before it. Queue time changed to only be drawn for rides.

Notes

  • A commit message should say what the change includes and why.
  • The summary should start with a verb in the present tense (e.g. Add, change, fix etc.).
  • If the first line of commit message is over 72 characters, GitHub's UI will fold it. Please keep the first line below this limit.
  • There has to be one line of space between the topic (first line) and body of commitmsg
  • If you cannot fit the description and your commit is large, consider splitting it into smaller chunks.
  • As of #11410 at least the basic commit message style will be enforced by CI.
Add a custom footer
Clone this wiki locally