Skip to content

Consider adding a changelog to track version history #69298

Description

@goransh-buh

Feature Request

Summary

A CHANGELOG.md file would help users understand what changed between versions and make upgrade decisions easier.

Motivation

When upgrading dependencies, developers need to know:

  • What bugs were fixed
  • What new features were added
  • Whether there are any breaking changes

Suggested Format

Follow the Keep a Changelog convention:

# Changelog

## [Unreleased]

## [1.2.0] - 2024-01-15
### Added
- New feature X
### Fixed  
- Bug with Y under Z conditions
### Changed
- Behaviour of Z is now more consistent

Additional Context

This is purely a documentation change with no code impact.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions