8
edits
Difference between revisions of "Commit Guidelines"
m
add BUILD: subsystem and minor grammatical improvements
m (add BUILD: subsystem and minor grammatical improvements) |
|||
| Line 37: | Line 37: | ||
</pre> | </pre> | ||
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. | Particularly critical is the first line: This first line is used in a short log format, and providing engine name, sound subsystem, backend name, or whatever - lets us 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 47: | Line 47: | ||
* '''TOOLS''': ScummVM tools module or built-in tools | * '''TOOLS''': ScummVM tools module or built-in tools | ||
* '''MIDI''': MIDI sound-related | * '''MIDI''': MIDI sound-related | ||
* '''BUILD''': Files related to building the project, makefiles, and related | |||
* '''ALL''': A change that covers multiple, or all, subsystems | * '''ALL''': A change that covers multiple, or all, subsystems | ||
* '''JANITORIAL''': Cross-subsystem cleanups and formatting changes | * '''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. | After the first line, an empty line is required which is used as the 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 == | ||