Skip to content

docs: add CHANGELOG.md seeded from the releases #314

Closed
#353
Closed
docs: add CHANGELOG.md seeded from the releases#314
#353
Assignees
Iqranawaz-debug
Labels
documentationImprovements or additions to documentationgood first issueGood for newcomers

Description

@kOaDT
kOaDT
opened on Sep 3, 2026

Context

34 tagged releases, no in-repo CHANGELOG.

Tasks

  • Add CHANGELOG.md (Keep a Changelog format) seeded from release notes.
  • Note the maintenance approach (manual, or generated from Conventional Commits — ~69% already comply).

Acceptance criteria

  • CHANGELOG.md covers all published versions and is linked from the README.

Files

  • CHANGELOG.md, README.md

Activity

  1. kOaDT
    added
    documentationImprovements or additions to documentation
    good first issueGood for newcomers
    on Sep 3, 2026
  2. kOaDT
    moved this to Backlog in OopsSec Store - Roadmapon Sep 3, 2026
  3. kOaDT
    added this to OopsSec Store - Roadmapon Sep 3, 2026

  4. Iqranawaz-debug commented on Oct 20, 2026

    @Iqranawaz-debug
    Iqranawaz-debug
    on Oct 20, 2026
    Contributor

    Hi! I'd like to work on this issue.

    I can create CHANGELOG.md using the published release notes, organize it according to Keep a Changelog, document the maintenance approach, and add a link in README.md.

    Is this issue available for me to take?

    Thank you!

  5. kOaDT commented on Oct 20, 2026

    @kOaDT
    kOaDT
    on Oct 20, 2026
    OwnerAuthor

    4. Hi! I'd like to work on this issue.
    I can create CHANGELOG.md using the published release notes, organize it according to Keep a Changelog, document the maintenance approach, and add a link in README.md.
    Is this issue available for me to take?
    Thank you!

    Hi @Iqranawaz-debug, thanks! 👍 It's yours.

    A few things before you start:

    • There are now 42 published releases, not 34. Please cover all of them, from 1.3.0 up to the latest one when you open the PR (2.22.0 right now). The three oldest tags have no v prefix (1.3.0, 1.4.0, 1.5.0), so the compare links at the bottom must use those exact names.
    • The release notes use their own headings (What's New, Improvements, Bug Fixes, Maintenance). Map them to the Keep a Changelog sections (Added, Changed, Fixed, Security, etc.) and keep entries short. Link each version to its GitHub release for the full notes.
    • Maintenance: I think it's better if the changelog stays manual and is updated with each release. A short note at the top of the file is enough.
    • CI runs Prettier on CHANGELOG.md, so run npm run format on your branch before pushing.

    If you have any question, don't hesitate to ask!

  6. kOaDT
    assigned
    Iqranawaz-debug
    on Oct 20, 2026
  7. kOaDT
    moved this from Backlog to In progress in OopsSec Store - Roadmapon Oct 20, 2026
  8. kOaDT
    closed this as completedin #353on Oct 20, 2026
  9. github-project-automation
    moved this from In progress to Done in OopsSec Store - Roadmapon Oct 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions