Skip to content
William Desportes edited this page Sep 15, 2020 · 6 revisions

When contributing code it is appreciated when a line in the ChangeLog file is included. Although the file itself if mostly self explanatory a few notes below may help to keep it consistent.

The ChangeLog file is included in the top-level directory of every version. The most recent version is available in the git webinterface; ChangeLog files are rotated yearly and entries from previous years are in the historical archive.

Format

Example:

- issue #00001 Added support for foo bar

Prefix:

  • - is bugfix or change to existing code
  • + is new feature

Reference to tracker item: (optional)

  • issue #

Description:

  • Describe what has been changed/fixed
  • Please keep it short and to the point
  • Please include more detailed description in the Git commit message
Clone this wiki locally