Description
Both package.json files in AlgoForge are at version 0.0.0 and there is no CHANGELOG.md. As the project grows and accepts open-source contributions, a changelog is essential for users and contributors to understand what changed between versions and for maintaining a release history. Without it, all version history is buried in commit messages.
Requirements
- Create a
CHANGELOG.md at the project root following the Keep a Changelog format.
- Update
app/package.json and backend/package.json version to 1.0.0.
- Document all current features under a
[1.0.0] section.
- Add a "Changelog" section to
CONTRIBUTING.md explaining that contributors must add their change to the [Unreleased] section in their PR.
Expected Behavior
New Contributor — Reads CHANGELOG.md to understand the project's release history and current feature set. Knows to add their change to the [Unreleased] section in their PR.
Release Manager — Creates a GitHub Release referencing the changelog. Moves [Unreleased] items to a dated version section on release.
Tasks
Acceptance Criteria
Description
Both
package.jsonfiles in AlgoForge are at version0.0.0and there is noCHANGELOG.md. As the project grows and accepts open-source contributions, a changelog is essential for users and contributors to understand what changed between versions and for maintaining a release history. Without it, all version history is buried in commit messages.Requirements
CHANGELOG.mdat the project root following the Keep a Changelog format.app/package.jsonandbackend/package.jsonversion to1.0.0.[1.0.0]section.CONTRIBUTING.mdexplaining that contributors must add their change to the[Unreleased]section in their PR.Expected Behavior
New Contributor — Reads
CHANGELOG.mdto understand the project's release history and current feature set. Knows to add their change to the[Unreleased]section in their PR.Release Manager — Creates a GitHub Release referencing the changelog. Moves
[Unreleased]items to a dated version section on release.Tasks
CHANGELOG.mdat the project root in Keep a Changelog format with[Unreleased]and[1.0.0]sections.[1.0.0](auth, dashboard, problems, roadmaps, forum, notes, leaderboard, daily challenges, AlgoBot, admin panel).app/package.json"version"to"1.0.0".backend/package.json"version"to"1.0.0".CONTRIBUTING.mdexplaining the[Unreleased]update process.Acceptance Criteria
CHANGELOG.mdexists at the project root in Keep a Changelog format.[1.0.0]section lists all major current features.package.jsonfiles reflect"version": "1.0.0".CONTRIBUTING.mdexplains the changelog update process for PRs.