Skip to content

Updating the changelog

Karol Lasończyk edited this page Feb 6, 2018 · 2 revisions

Updating the changelog

The changelog file was created to track changes in the nrfx project. Remember that this file is created for developers. Make it simple and clear.

Adding entries

The changelog file is split into two main sections:

  • A Version section that contains the release version and date.
  • A Changes section that is connected to the Version section.

Changes sections are strictly connected to a release version. New change descriptions must be added in one of the four sections:

  • Added - if a new feature was added.
  • Changed - if code was updated or API was changed.
  • Fixed - if a bug was fixed.
  • Removed - if a function or code functionality was removed.

Every entry should be written in the past tense.

Example

Every change must be placed in an appropriate section in the unreleased version. Only code owners can create releases and assign version numbers to them.

# Changelog
All notable changes to this project are documented in this file.

## [Unreleased]
### Added
- Added function for checking if a TIMER instance is enabled.

### Changed
- Refactored SPIM driver and HAL.

### Fixed
- Fixed definitions related to compare channels in the TIMER HAL.

## [1.2.3] - 2020-02-20

References