Maintaining ChangeLog

Maintaining ChangeLog

Any main module of OpenVAS maintains a "ChangeLog" file in its root directory. It is a GNU-style ChangeLog and syntax highlighting for your favorite editor should work out of the box.

Some rules for the ChangeLog file:

• Keep the GNU-style syntax for your new entries. Your syntax-highlighting editor will support you.
• Make atomic commits: Always include the updated ChangeLog file together with the changed files.
• List any changed file explicitly in the ChangeLog, even if there were many. See the ChangeLog file for examples how to write the change information.

Note: The ChangeLog is intentionally not created automatically. Before committing, developers are forced to reflect on the changes they did. This regularly leads to detection of suboptimal changes or identification of intermediate (try-out/debugging) changes that of course should not go to the main repository.

The developer's ChangeLog is the base for writing the user's CHANGES when a new release is prepared.

Maintaining ChangeLog