Good practices for commits

From OpenFLUID

Jump to: navigation, search
  • Before committing, the code must be entirely compiled and built without error
  • Before committing, the code must pass all tests successfully
  • A commit should be as atomic as possible: 1 task/1 bug fix = 1 commit
  • A commit must always contain a message explaining the reason and/or content of the commit
  • Each part of the commit message must start with a '*' character
  • A commit message must refer to a task/bug ticket number if exists, using the following notation : [sfTrac #n], where n is the number of the ticket in the Trac tracking system. The tracking system is available on SourceForge at https://sourceforge.net/apps/trac/openfluid/


Commit message example:

* [sfTrac #98] Added About dialog
* Cleaned code
Personal tools