Keeping a CHANGELOG: formats and tools
Why it matters
A changelog tells users what changed before they upgrade. DevOps Check accepts CHANGELOG, CHANGES, HISTORY or NEWS in any case, release notes under docs/, and tools like changesets or release-please.
How to fix it
What to do: Create
CHANGELOG.md following the Keep a Changelog format.# Changelog
All notable changes are documented here.
Format: [keepachangelog.com](https://keepachangelog.com/en)
## [Unreleased]
### Added
- New features
## [1.0.0] - 2024-01-15
### Added
- Initial release
### Fixed
- Critical authentication bug fixed
Does your repository pass this check?
Free for public GitHub repositories, no account needed. 50+ DevOps and security checks in about ten seconds.