Skip to content

CHANGELOG Format

Jump to bottom
John T. Wodder II edited this page Apr 9, 2023 · 4 revisions

A changelog is a Markdown or reStructuredText file containing an optional intro and one or more sections, each one corresponding to a different version/release.

  • Each section begins with a section title followed by a line of three or more hyphens. The section title must be in one of the following formats:

    • vVERSION (DATE) (where DATE is in YYYY-MM-DD format)
    • vDATEVERSION (where DATEVERSION is in YYYY.M.D format)
    • vVERSION (in development)
    • In Development

  • The remainder of each section after the starting lines is freeform.

  • Sections should be separated by blank lines.

  • The intro is all text before the first section. It may contain other sectional headings (albeit ones not made with hyphens).

Clone this wiki locally