Skip to content

Updating the Changelog

David Gregorczyk edited this page Mar 14, 2023 · 1 revision

Updating the Changelog

On root level, this repository includes a CHANGELOG.md file. This file contains a list of changes to past releases and the current master trunk. Once a pull request is ready to be merged to master, the author of the pull request shall update the CHANGELOG.md file by adding rows to the [Unreleased] section. Depending on if the author added, updated and/or removed content, a brief description of the change is added to the respective sections Added, Changed and/or Removed. The brief description shall be a one-liner that refers to the issue that requested the update in order to allow for the interested reader to obtain details.

Example of a change with the brief description Lorem Ipsum of issue 456.
## [Unreleased]

### Added

### Changed

Lorem Ipsum (#456).

### Removed

## 1.1.0

### Added

Requirement 1005 that specifies some fancy stuff (#123).

Clone this wiki locally