Changelog guidelines

The changelog statements are written in Markdown code, please see the GitHub Markdown help page for a syntax overview. You could either clone this wiki repository (recommended), or update individual pages live, although it's not known how well concurrent live updates will work.

• The changelogs are divided between minor releases, and patch releases are separated by a headline each.
  • Use three hashes for a headline.
• Always forward-copy the changelog statement to the later versions, since there's no reliable way to indicate which changes of a previous minor release are included in a later release.
  • If a changelog statement only applies to certain minor releases, only copy it to the relevant logs.
• Each changelog statement should be one bullet point, and if applicable contain a link to a pull request in a sub-bullet point.
• Changelog statements are divided between different modules, and each module with changes in the relevant version should be headlined with a simple colon.
• If a change is made to fix a reported GitHub issue, this should be indicated by linking the relevant issue in the changelog statement.

For 3.0 and later versions, the changelog is not divided between Community, Advanced and Enterprise editions, but instead a sub-bullet point will mark a change as enterprise-only (Advanced does not exist in 3.x). All other changelog statements are assumed to exist in all three editions.

See the example below for reference:

2.3.4

Cypher:

• A standard bugfix changelog statement
• Fixes #1234 -- Summary of reported issue
• An enterprise-only feature is now finished
  • Enterprise edition specific

Kernel:

• Another standard bugfix changelog statement
• This change was made to the 2.2 branch, but copied here since it was also forward-merged

2.3.3

Server:

• An older change
  • This change does not apply to later minor releases