This is an old revision of the document!


GIT Commit Guidelines

Not an absolute MUST, but it SHOULD be used almost always. It helps to track changes and follow the development easier (better commit mail messages and Changelogs are easier to generate).

Commit message

Please create the commit messages following the git convention:

  • start with one short line, preferably less then 50 chars summarising the changes (this is referred later as "first line of the commit message")
  • then one empty line
  • then a more detailed description

See:

Generic Guidelines

  • split big changes across many parts of the code (e.g., parser, memory manager, modules, ..) in smaller chunks that affect only one part. It is easier to track the changes

Core Commits

  • prefix the first line of the commit message with "core:"

Module Commits

  • prefix the first line of the commit message with "module name:"

Library Commits

  • prefix the first line of the commit message with "library name:"

Navigation

Wiki

Other

QR Code
QR Code devel:git-commit-guidelines (generated for current page)