diff options
| author | Pierre GRANDIN <pgrandin@users.noreply.github.com> | 2019-09-26 16:04:01 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-26 16:04:01 -0600 |
| commit | 2233f4e3c7b24ddbf79f2e0285dd3fba7f287d59 (patch) | |
| tree | d8444e6a5d3751ffa29af8669f825196063ec938 /docs/development/commit_guidelines.rst | |
| parent | 32307a8d730fa0cefcf9358788ffd3d0447edba2 (diff) | |
| parent | 8a0630bcb0450631a48c2dc8911c5ef54f1baef7 (diff) | |
| download | navit-aerostitch/short_circuit.tar.gz | |
Merge branch 'trunk' into aerostitch/short_circuitaerostitch/short_circuit
Diffstat (limited to 'docs/development/commit_guidelines.rst')
| -rw-r--r-- | docs/development/commit_guidelines.rst | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/development/commit_guidelines.rst b/docs/development/commit_guidelines.rst index dff76fac2..52fdad8b2 100644 --- a/docs/development/commit_guidelines.rst +++ b/docs/development/commit_guidelines.rst @@ -24,29 +24,29 @@ 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>[|Optional comments]` +We have agreed about using the following syntax : `<Action>:<component>:<log message>[|Optional comments]` Examples : - Fix:Core:Fixed nasty bug in ticket #134 - Fix:GTK:Fixed nasty bug about destination button|Thanks someguy for the patch! + * Fix:Core:Fixed nasty bug in ticket #134 + * Fix:GTK:Fixed nasty bug about destination button|Thanks someguy for the patch! Action can be something like: -* Fix (bug fix) -* Add (new feature) -* Patch -* Refactoring (does not change behavior of the program) + * Fix (bug fix) + * Add (new feature) + * Patch + * Refactoring (does not change behavior of the program) It allows the changes to be sorted by categories The most common components are: -* core -* gui/gtk -* gui/internal -* graphics/gtk -* graphics/qt_qpainter -* graphics/opengl -* mapdriver -* tools + * core + * gui/gtk + * gui/internal + * graphics/gtk + * graphics/qt_qpainter + * graphics/opengl + * mapdriver + * tools The comment part is optional. Useful for when applying a patch for example, and giving credits. The part after `|` will not appear in the wiki. |