Skip to content

[Docs]: Add CHANGELOG.md following Keep a Changelog format #91

@rosspeili

Description

@rosspeili

What needs to be fixed?

The repository has no CHANGELOG.md. Release history exists only on the GitHub Releases page, which is not visible in a local clone, not browseable offline, and not accessible to users who install via pip and want to understand what changed between versions.

Add CHANGELOG.md at the repository root following the Keep a Changelog format, populated retrospectively from existing GitHub release notes starting at v0.2.0.

Standard sections per version entry: Added, Changed, Fixed, Removed.

Link CHANGELOG.md from README.md (e.g. in the navigation or badges section).

This is a documentation-only change. No code changes required. The file is maintained manually alongside each release — no automation needed in v1.

Affected Page

CHANGELOG.md , README.md

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers
No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions