Skip to content

add CHANGELOG.md seeded from existing tags #116

Description

@sujithps

Summary

The repo has git tags (v0.1.1, v0.1.0, v0.1.0-alpha.4, v0.1.0-alpha.3) but no CHANGELOG.md and no published GitHub Releases, so followers get no human-readable history of what changed between versions.

Scope

  • Add a top-level CHANGELOG.md in Keep a Changelog format.
  • Seed one section per existing tag, summarizing changes from git log between tags (Added / Changed / Fixed).
  • Add an ## [Unreleased] section at the top for ongoing work.
  • Optional: a line in CONTRIBUTING.md asking PRs to add a changelog entry.

Acceptance criteria

  • CHANGELOG.md covers every existing tag, newest first.
  • Format validates against Keep a Changelog structure.

Note

Pairs with publishing GitHub Releases for the existing tags (a maintainer action, since it needs write access).

Proposed as a good first issue; a maintainer will apply the label.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions