Difference between revisions of "Commit Guidelines"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Commit-Guidelines moved to Commit Guidelines)
(Commit guidelines)
 
(12 intermediate revisions by 7 users not shown)
Line 1: Line 1:
In the past, we were quite lax about commit messages. Well, we won't start beating people up, but I think we should at least all be aware of the issue at hand; namely, what distinguishes good commit messages from bad ones. I hope that this page will help us all to improve our commit messages a bit...
+
This page contains some guidelines about commits and commit messages.
  
The following is an excerpt from the FreeBSD Committer's Guide <http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/article.html> and sums up quite nicely what I think:
+
== Commit guidelines ==
 +
 
 +
Commits shouldn't contain multiple unrelated changes; try and make piecemeal changes if you can, to make it easier to review and merge. In particular, don't commit style/whitespace changes and functionality changes in a single commit.
 +
 
 +
If you change shared common code, then (while not necessarily in the same commit, due to the above guideline!) you should also make at least a best-effort attempt to make sure all of the engine/backend code stays working.
 +
 
 +
Assure that ScummVM compiles with every commit. In case of regressions, this helps to track down the commit introducing the regression.
 +
 
 +
== Commit message formatting ==
 +
We won't start beating people up, but everyone should at least all be aware of the issue at hand; namely, what distinguishes good commit messages from bad ones. This page hopes to help all of us to improve our commit messages a bit... The benefit will be to the full team as commit logs will be more readable.
 +
 
 +
The rules on commit messages are the following (they're standard to git, except our SUBSYSTEM requirement):
 +
<pre>
 +
SUBSYSTEM: Short (50 chars or less) summary of changes
 +
 
 +
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
 +
</pre>
  
== Excerpt from the FreeBSD Committer's Guide ==
+
Particularly critical is the first line: This first line is used in short log format, and providing engine name, sound subsystem, backend name or whatever lets decide quickly should reviewers look deeply into commit or skip.
Good commit messages are important. They tell others why you did the changes you did, not just right here and now, but months or years from now when someone wonders why some seemingly illogical or inefficient piece of code snuck into your source file. It is also an invaluable aid to deciding which changes to MFC and which not to MFC.
 
  
* Commit messages should be clear, concise and provide a reasonable summary to give an indication of what was changed and why.
+
The subsystem names which were used so far:
* Commit messages should provide enough information to enable a third party to decide if the change is relevant to them and if they need to read the change itself.
+
* '''AGOS''', '''SCI''', '''SCUMM''', whatever engine name
* Avoid committing several unrelated changes in one go. It makes merging difficult, and also makes it harder to determine which change is the culprit if a bug crops up.
+
* '''SDL''', '''ANDROID''', '''WII''', '''NDS''', whatever backend name
* Avoid committing style or whitespace fixes and functionality fixes in one go. It makes merging difficult, and also makes it harder to understand just what functional changes were made. In the case of documentation files, it can make the job of the translation teams more complicated, as it becomes difficult for them to determine exactly what content changes need to be translated.
+
* '''OSYSTEM''': our middleware code
* Avoid committing changes to multiple files in one go with a generic, vague message. Instead, commit each file (or small, related groups of files) with tailored commit messages.
+
* '''I18N''': internationalization
 +
* '''GUI''': all gui-related
 +
* '''TOOLS''': ScummVM tools module or built-in tools
 +
* '''MIDI''': MIDI sound-related
 +
* '''ALL''': A change that covers multiple, or all, subsystems
 +
* '''JANITORIAL''': Cross-subsystem cleanups and formatting changes
  
 +
After first line, an empty line is required which is used as separator. This first line has to be short and less than 50 characters so the log will fit on a standard 80-column terminal.
  
== Examples ==
+
== Commit messages ==
 
Commit messages like the following aren't very helpful:
 
Commit messages like the following aren't very helpful:
* "not needed"  --> uhm, what is not needed?
+
* "not needed"  -> uhm, what is not needed?
* "bye bye" --> was some obsolete code removed? Or did somebody leave the project? Or what?
+
* "bye bye" -> was some obsolete code removed? Or did somebody leave the project? Or what?
 
* "Reverse to match values" -> Reverse which values to match what?
 
* "Reverse to match values" -> Reverse which values to match what?
 
* "Move to supported games" -> move what?
 
* "Move to supported games" -> move what?
Line 23: Line 61:
 
* "One more file to fix"  
 
* "One more file to fix"  
 
* "This difference only applies to SCUMM7+" -> which difference?
 
* "This difference only applies to SCUMM7+" -> which difference?
 +
* "" -> empty commit messages are about the worst you can do :-/ (short of insults and totally offtopic messages).
  
Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you commited just before that particular commit!
+
Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you committed just before that particular commit!
  
 
Compare this to
 
Compare this to
Line 32: Line 71:
 
* "Add patch #1374870 - New Lure of the Temptress module"
 
* "Add patch #1374870 - New Lure of the Temptress module"
  
Don't be too verbose in your message either. You don't have to tell people what the next step in the grand scheme are in a long paragraph.
+
Don't be too verbose in your message either. You don't have to tell people what the next step in the grand scheme is in a long paragraph.
 +
 
 +
 
 +
== More  to read ==
 +
 
 +
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
 +
 
 +
http://kernel.org/pub/software/scm/git/docs/user-manual.html#creating-good-commit-messages
 +
 
 +
The following is an excerpt from the FreeBSD Committer's Guide <http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/article.html> and sums up quite nicely what I think:
 +
 
 +
=== Excerpt from the FreeBSD Committer's Guide ===
 +
Good commit messages are important. They tell others why you did the changes you did, not just right here and now, but months or years from now when someone wonders why some seemingly illogical or inefficient piece of code snuck into your source file. It is also an invaluable aid to deciding which changes to MFC and which not to MFC.
 +
 
 +
* Commit messages should be clear, concise and provide a reasonable summary to give an indication of what was changed and why.
 +
* Commit messages should provide enough information to enable a third party to decide if the change is relevant to them and if they need to read the change itself.
 +
* Avoid committing several unrelated changes in one go. It makes merging difficult, and also makes it harder to determine which change is the culprit if a bug crops up.
 +
* Avoid committing style or whitespace fixes and functionality fixes in one go. It makes merging difficult, and also makes it harder to understand just what functional changes were made. In the case of documentation files, it can make the job of the translation teams more complicated, as it becomes difficult for them to determine exactly what content changes need to be translated.
 +
* Avoid committing changes to multiple files in one go with a generic, vague message. Instead, commit each file (or small, related groups of files) with tailored commit messages.

Latest revision as of 09:21, 29 April 2016

This page contains some guidelines about commits and commit messages.

Commit guidelines

Commits shouldn't contain multiple unrelated changes; try and make piecemeal changes if you can, to make it easier to review and merge. In particular, don't commit style/whitespace changes and functionality changes in a single commit.

If you change shared common code, then (while not necessarily in the same commit, due to the above guideline!) you should also make at least a best-effort attempt to make sure all of the engine/backend code stays working.

Assure that ScummVM compiles with every commit. In case of regressions, this helps to track down the commit introducing the regression.

Commit message formatting

We won't start beating people up, but everyone should at least all be aware of the issue at hand; namely, what distinguishes good commit messages from bad ones. This page hopes to help all of us to improve our commit messages a bit... The benefit will be to the full team as commit logs will be more readable.

The rules on commit messages are the following (they're standard to git, except our SUBSYSTEM requirement):

SUBSYSTEM: Short (50 chars or less) summary of changes

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

Particularly critical is the first line: This first line is used in short log format, and providing engine name, sound subsystem, backend name or whatever lets decide quickly should reviewers look deeply into commit or skip.

The subsystem names which were used so far:

  • AGOS, SCI, SCUMM, whatever engine name
  • SDL, ANDROID, WII, NDS, whatever backend name
  • OSYSTEM: our middleware code
  • I18N: internationalization
  • GUI: all gui-related
  • TOOLS: ScummVM tools module or built-in tools
  • MIDI: MIDI sound-related
  • ALL: A change that covers multiple, or all, subsystems
  • JANITORIAL: Cross-subsystem cleanups and formatting changes

After first line, an empty line is required which is used as separator. This first line has to be short and less than 50 characters so the log will fit on a standard 80-column terminal.

Commit messages

Commit messages like the following aren't very helpful:

  • "not needed" -> uhm, what is not needed?
  • "bye bye" -> was some obsolete code removed? Or did somebody leave the project? Or what?
  • "Reverse to match values" -> Reverse which values to match what?
  • "Move to supported games" -> move what?
  • "Forgot *.xpm files" -> forgot what about them?
  • "One more file to fix"
  • "This difference only applies to SCUMM7+" -> which difference?
  • "" -> empty commit messages are about the worst you can do :-/ (short of insults and totally offtopic messages).

Always keep in mind -- those message are often read *without* seeing the diffs, and without the possibility to see which other files you committed just before that particular commit!

Compare this to

  • "Change CVS keywords to SVN keywords"
  • "Move Pajama3 to supported games"
  • "Added compression tool for kyra speech files."
  • "Add patch #1374870 - New Lure of the Temptress module"

Don't be too verbose in your message either. You don't have to tell people what the next step in the grand scheme is in a long paragraph.


More to read

http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

http://kernel.org/pub/software/scm/git/docs/user-manual.html#creating-good-commit-messages

The following is an excerpt from the FreeBSD Committer's Guide <http://www.freebsd.org/doc/en_US.ISO8859-1/articles/committers-guide/article.html> and sums up quite nicely what I think:

Excerpt from the FreeBSD Committer's Guide

Good commit messages are important. They tell others why you did the changes you did, not just right here and now, but months or years from now when someone wonders why some seemingly illogical or inefficient piece of code snuck into your source file. It is also an invaluable aid to deciding which changes to MFC and which not to MFC.

  • Commit messages should be clear, concise and provide a reasonable summary to give an indication of what was changed and why.
  • Commit messages should provide enough information to enable a third party to decide if the change is relevant to them and if they need to read the change itself.
  • Avoid committing several unrelated changes in one go. It makes merging difficult, and also makes it harder to determine which change is the culprit if a bug crops up.
  • Avoid committing style or whitespace fixes and functionality fixes in one go. It makes merging difficult, and also makes it harder to understand just what functional changes were made. In the case of documentation files, it can make the job of the translation teams more complicated, as it becomes difficult for them to determine exactly what content changes need to be translated.
  • Avoid committing changes to multiple files in one go with a generic, vague message. Instead, commit each file (or small, related groups of files) with tailored commit messages.