Skip to content

Add a CHANGELOG and a documented release/versioning process #1024

Description

@1nonlypiece

📌 Description

There is a backend changelog doc but no top-level CHANGELOG or documented release process for the frontend, so released changes are hard to track for contributors and users.

🎯 Requirements and Context

  • Add a Keep-a-Changelog style CHANGELOG with an Unreleased section.
  • Document the release/versioning process and how entries are added.
  • Cross-link the existing backend changelog doc.

🛠️ Suggested Execution

1. Fork the repo and create a branch

git checkout -b docs/changelog-release

2. Implement changes

  • CHANGELOG.md — new changelog with Unreleased section
  • docs/RELEASE_PROCESS.md — document versioning and release steps
  • docs/backend-changelog.md — cross-link from the new process (extend)

3. Test and commit

  • Run the suite: pnpm test (or npm test) and pnpm lint.
  • Cover edge cases: unreleased section maintained; semver guidance; entry categories; links to backend changelog.
  • Include test output (and a short note of any behavioural findings) in the PR.

Example commit message

docs: add changelog and release process

✅ Guidelines

  • Minimum 95% test coverage on the new/changed lines.
  • Clear, reviewer-friendly documentation and a small, focused diff.
  • No regressions against existing suites.
  • Timeframe: 96 hours.

🏷️ Labels

type-documentation · area-frontend · MAYBE REWARDED · GRANTFOX OSS · OFFICIAL CAMPAIGN

💬 Community & Support

  • Join the CommitLabs contributor Discord to coordinate, ask questions, and get
    unblocked fast: https://discord.gg/WV7tdYkJk
  • Please introduce yourself in the channel before you start so we can avoid
    duplicate work, pair you with a reviewer, and get your PR merged quickly.
  • Maintainers actively triage this channel and aim for fast, clear, respectful
    reviews — reach out any time you're blocked.

Metadata

Metadata

Assignees

No one assigned

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions