Commit Message Guidelines - Ludeon/RimWorld-Thai GitHub Wiki

Short (72 chars or less) summary

More detailed explanatory text. Wrap it to 72 characters. The blank
line separating the summary from the body is critical (unless you omit
the body entirely).

Write your commit message in the imperative: "Fix bug" and not "Fixed
bug" or "Fixes 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, followed by a
  single space. Use a hanging indent.

A properly formed git commit, header line should always be able to complete the following sentence

If applied, this commit will <your header line here>

Formatting the Commit Message

Each commit message consists of a header, a body and a footer.

The header has a special format that includes: a type and a subject:

<type> <subject>

<body>

<footer>

The header line is mandatory.

Type

Capitalize first letter.

Must be one of the following:

  • Add -- new translation which mostly replace TODO
  • Edit -- change exist translation to better or more correct one
  • Update -- when combine Add + Edit types
  • Fix -- typos, styling for better reability, formatting keyed, etc - that will NOT change meaning of translations
  • Clean -- specific for commits when after game update > run the In-Game Cleaner tool > fixed game-breaking changes

Subject

The subject contains succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • no dot (.) at the end

Body

Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes".

Explain what and why you have done something.

In most cases, you can leave out details about how a change has been made.

Footer

The place to reference GitHub issues that this commit closes.

Platform will automatically converts issue ids (e.g. #123) to links referring to the related issue.

…

Fixes #123, #124

Revert

If the commit reverts a previous commit, it should begin with Revert: , followed by the header of the reverted commit.

In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.

A commit with this format is automatically created by the git revert command.

Example for a commit message

Add new translates from game vN.X.Y

Add more in rulePack list

Edit confuse word when see in game

Fix style to proper word-wrap in game UI button

Fix style to be easily readout at glance

Update complete all def inject

Fix typos of word `Ball`

Fix keyed symbol {N} to {N_label}

Clean for RimWorld version Y.X.N compatible

Great git commit message style

  • Use the imperative mood
  • Separate header from body with a blank line
  • Capitalize the header and each paragraph
  • Do not end the header with a period
  • Wrap lines at 72 characters
  • Use the body to explain what and why you have done something.

Information in commit messages

  • Describe why a change is being made.
  • How does it address the issue?
  • What effects does the patch have?
  • Do not assume the reviewer understands what the original problem was.
  • Do not assume the code is self-evident/self-documenting.
  • Read the commit message to see if it hints at improved code structure.
  • The first commit line is the most important.
  • Describe any limitations of the current code.
  • Do not include patch set-specific comments.

Details for each point and good commit message examples can be found on https://wiki.openstack.org/wiki/GitCommitMessages#Information_in_commit_messages

Sources

⚠️ **GitHub.com Fallback** ⚠️