2,051
edits
Difference between revisions of "Commit Guidelines"
Jump to navigation
Jump to search
m
rewording
m (→Rules: remove outdated sentence; hopefully everyone is writing commit messages like this now :P) |
m (rewording) |
||
| Line 1: | Line 1: | ||
In the past, | In the past, ScummVM was quite lax on commit message formatting. Well, 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. | ||
== Rules == | == Rules == | ||
| Line 27: | Line 27: | ||
</pre> | </pre> | ||
Particularly | 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: | The subsystem names which were used so far: | ||
| Line 38: | Line 38: | ||
* '''MIDI''': MIDI sound-related | * '''MIDI''': MIDI sound-related | ||
After first line | 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. | ||
== Good Practice == | == Good Practice == | ||