CHANGELOG - Structure Example

When we update our project, the Changelog should have the history of what we added, changed, removed, fixed, etc.

In order to do that, we attach in this section, an example of the Changelog Structure.

Labels used:

• Added: This label is used in the Changelog file to indicate new features, functionalities, or elements that have been introduced to the project. It typically highlights additions that enhance the project's capabilities or introduce new components.

• Chores: The "Chores" label is used in the Changelog file to denote tasks related to maintenance, organization, or housekeeping of the project. These tasks may include code refactoring, documentation updates, or other non-functional improvements.

• Removed: The "Removed" label in the Changelog file signifies the removal or elimination of specific features, functionalities, or elements from the project. It indicates that certain components or aspects are no longer present or supported in the current version.

• Fixed: The "Fixed" label is used to indicate the resolution of bugs, issues, or errors in the project. It signifies that problems reported or identified by users or developers have been addressed and resolved.

• Changed: The "Changed" label is used in the Changelog file to describe modifications or alterations made to existing features, functionalities, or elements in the project. It suggests that certain aspects have been updated or modified, often providing more details about the specific changes.

• Task: The "Task" label is used in the Changelog file to denote general tasks or activities performed as part of the project. It can encompass various types of work, such as implementation of new functionalities, improvements, or maintenance tasks.

• Security: The "Security" label in the Changelog file highlights changes related to security enhancements or fixes. It typically indicates updates made to address vulnerabilities, strengthen security measures, or implement best practices to safeguard the project.

• Deprecated: The "Deprecated" label is used to indicate features, functionalities, or elements that have been marked as outdated or discouraged. It implies that certain components are no longer recommended for use and may be removed in future versions of the project. Developers are advised to avoid using deprecated elements and instead transition to alternative solutions or approaches.

---

Changelog Example

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.

Unreleased

Added

Added Dutch translation

Fixed

Fixed foldouts in Dutch translation

v1.1.0 - 2019-02-15

---

Added

Danish translation from @frederikspang.

Georgian translation from @tatocaster.

Changelog inconsistency section in Bad Practices

Changed

Fixed typos in Italian translation from @lorenzo-arena.

Fixed typos in Indonesian translation from @ekojs.