Creating a changelog 

Create a changelog (*.md, *.txt or *.pdf) to allow users of your app to more quickly and easily track changes between versions.

There is no standardized changelog format, but Phoenix Contact recommends to use the information provided by the project Keep a Changelog as a guide (as we have also done in the following).

What you should consider in your changelog: 

  • Create an entry for every single version. 
  • List the release date of each version in each entry.
  • Set the newest entry to the top.
  • Mention whether you follow semantic versioning(MAJOR.MINOR.PATCH). 
  • Group the same types of changes.
    At a minimum, consider these types of changes:
    • Added (new features)
    • Changed (changes in functionality)
    • Deprecated (functions that will be removed soon)
    • Removed (removed functions)
    • Fixed (bug fixes)
    • Security (in case of security vulnerabilities)

Example changelog:

# Changelog
All notable changes to this project will be documented in this file.
[//]: # (The format is based on [Keep a Changelog],
and this project adheres to [Semantic Versioning]
## [1.2.0] - 2019-05-27
### Added 
- New library version added 
### Changed 
- Changed the data logger session to the correct values
### Fixed
- Error handling
### Removed 
- Default values of at least one function block
## [1.1.0] - 2019-02-15
### Added
- Option to store historical Events
### Changed
- Functional changes of at least one function block
## [1.0.0] - 2017-06-20
- initial version






•  Web browser recommendation: Chrome/Edge 88 or newer, Firefox ESR 90 or neweror Safari  • 
• Published/reviewed: 2024-06-04 • Revision 15 •