Ideal State Gap
The CHANGELOG.md file contains a maintained changelog with version entries. The ideal state requires it to either be absent or contain only a note directing readers to GitHub Releases.
Current State
CHANGELOG.md contains detailed version history with entries for v0.1.0 through v0.11.4.
Expected State
CHANGELOG.md should either:
- Be removed entirely, OR
- Contain only a brief note like: "See GitHub Releases for the changelog."
Checklist
Ideal State Gap
The
CHANGELOG.mdfile contains a maintained changelog with version entries. The ideal state requires it to either be absent or contain only a note directing readers to GitHub Releases.Current State
CHANGELOG.md contains detailed version history with entries for v0.1.0 through v0.11.4.
Expected State
CHANGELOG.md should either:
Checklist