-
Notifications
You must be signed in to change notification settings - Fork 7
docs: implement automated CHANGELOG tracking #10
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers
Description
Problem Statement
Users and contributors currently have no way to see a high-level summary of changes between versions. Manually tracking every commit is tedious and prone to error.
Proposed Solution
- Add a
CHANGELOG.mdfile to the root of the repository. - Adopt a standard like Keep a Changelog.
- (Optional) Investigate automated tools like
conventional-changelogor GitHub Actions to generate entries from specially formatted commit messages.
Alternatives Considered
None. A clear changelog is essential for open-source project transparency.
Priority
Medium 🟡
Additional Context
This is a good-first-issue that helps improve project communication and versioning clarity.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomers