76
edits
Difference between revisions of "Commit Guidelines"
Jump to navigation
Jump to search
Added documentation details
m (add BUILD: subsystem and minor grammatical improvements) |
(Added documentation details) |
||
| Line 8: | Line 8: | ||
Assure that ScummVM compiles with every commit. In case of regressions, this helps to track down the commit introducing the regression. | Assure that ScummVM compiles with every commit. In case of regressions, this helps to track down the commit introducing the regression. | ||
Changes to user facing elements and common code also requires proper documentation. | |||
== Commit message formatting == | == Commit message formatting == | ||
| Line 73: | Line 75: | ||
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. | 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. | ||
== Documentation == | |||
Commits and PR should follow our documentation guidelines as part of the submission process. Documentation falls under two categories: User facing and Developer related | |||
=== User facing === | |||
Any user facing changes must also have proper documentation. These commits fall under the '''DOCS''' subsystem. For information on how to commit and build our docs portal can be found at the [[Developer Central]] | |||
Example of changes that require accompanying documentation: | |||
* '''GUI''' - New features, text changes of existing UI elements, addition of UI options / elements, Engine/Game specific settings | |||
* '''INI''' - Added keys and groups | |||
* '''Keymap''' - New keymaps, or change to existing keymaps | |||
* '''Ports''' - New ports, changes to documented ports | |||
* '''Features''' - Brand new features, for example Cloud Integratio | |||
=== Developer changes: === | |||
Any code contributions to '''common''' code outside of '''engines''' and '''backends''' must be accompanied with proper doxygen style comments. This includes but not limited to: | |||
* New methods | |||
* Signature changes | |||
* Changes to documented and undocumented methods | |||
* New classes | |||
== More | Documentation can be committed separately under the '''DOXYGEN''' subsystem. | ||
Code contributions in engines and backends do not have a hard requirement for doxygen style comments, but they are encouraged. | |||
== More to read == | |||
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||