Skip to content

commits

retep998 edited this page Apr 9, 2012 · 1 revision

Commit Message Template

Summary of entire commit (if this is too big, then your commit is too big, and that's a problem). If you only worked on one issue in a commit, then merge the summary with the line describing which issue you worked on
Each change you made
Takes up another line
When working on an issue (#1)
* List details about the specific changes you made for an issue
* After the line that says you worked on the issue
When an issue has been fixed (fixes #2)
When an issue has been completed, something other than a fix (closes #3)
If you're done with an issue, but it still needs testing/verification (#4)
If you made one big change which covers multiple issues
* Mention the individual issues in the details (#5)
* If a single detail covers multiple issues (fixes #6, closes #7)
Likewise for a single small change (#8, fixes #9)

Make sure you sign off your commit messages using git's sign-off stuff (don't write it in yourself).
This helps us keep track of who wrote a commit, even if it gets slaughtered by cherry-picking and other weird things.

When doing a merge, always keep git's default merge commit message. If there were conflicts, keep the messages about which files were conflicted, and if you made any substantial modifications to fix the conflicts, make sure you list them after the conflicted file. Do NOT add any changes to the merge which are not directly related to the merging. If stuff is crashing after the merge, that's fine. Just make a new commit which fixes the crashes, and push them together.

Clone this wiki locally