Skip to content

feat: Add CHANGELOG.md (Keep a Changelog format) #51

Description

@johnny603

Is your feature request related to a problem? Please describe.

The repo has 30+ merged PRs (recent: #47, #32, #31, #26, #24, #23) and ships a
versioned API under /api/v1/..., but there is no CHANGELOG.md. Users
upgrading Lux, or clients depending on /api/v1/..., have no way to see what
changed between revisions without reading the git log.

Describe the solution you'd like

Add CHANGELOG.md at the repository root using the Keep a Changelog 1.1.0
format with Semantic Versioning:

Describe alternatives you've considered

  • Auto-generating via release-drafter or git-cliff — rejected for the first
    cut, since a hand-seeded file is faster to land and can be automated later.
  • Relying on GitHub Releases only — rejected, because releases are empty and the
    file works offline (the repo ships in a tarball / Docker image).

Additional context

  • CONTRIBUTING.md could gain a one-line "update CHANGELOG before merging"
    note, but that is optional and out of scope for the first PR.
  • PR numbers in entries match the git log already on main.


This repo is using Opire - what does it mean? 👇
💵 Everyone can add rewards for this issue commenting /reward 100 (replace 100 with the amount).
🕵️‍♂️ If someone starts working on this issue to earn the rewards, they can comment /try to let everyone know!
🙌 And when they open the PR, they can comment /claim #51 either in the PR description or in a PR's comment.

🪙 Also, everyone can tip any user commenting /tip 20 @johnny603 (replace 20 with the amount, and @johnny603 with the user to tip).

📖 If you want to learn more, check out our documentation.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions