Commit guidelines

From Navit's Wiki
Revision as of 12:34, 8 January 2008 by KaZeR (talk | contribs) (New page: Here are the current guidelines if you want to commit something : ==='Core' components changes=== Do not modify a 'core' component without discussing it first with the project leads ===F...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Here are the current guidelines if you want to commit something :

'Core' components changes

Do not modify a 'core' component without discussing it first with the project leads

Format of the commit log

Since we are too lazy to maintain a changelog, we have a script which parses the commit logs and generate a changelog for us.

We have agreed about using the following syntax :

<Action>:<component>:<log message>

Action can be something like:

  • Fix
  • Add
  • Patch

It allows the changes to be sorted by categories

Component is the component field in the bug tracker. The most common are :

  • core
  • gui/gtk (often shortened as 'gtk')
  • gui/cegui (often shortened as 'cegui')
  • graphics/gtk
  • graphics/opengl
  • mapdriver
  • tools

...

About the log message, it's up to you :)