Как вести CHANGELOG: форматы и инструменты
Почему это важно
Changelog говорит пользователям, что изменилось, до обновления. DevOpsCheck засчитывает CHANGELOG, CHANGES, HISTORY или NEWS в любом регистре, release notes в docs/ и инструменты вроде changesets или release-please.
Как исправить
Что сделать: Создайте
CHANGELOG.md в формате Keep a Changelog.# Changelog
Все значимые изменения документируются здесь.
Формат: [keepachangelog.com](https://keepachangelog.com/ru)
## [Unreleased]
### Added
- Новые возможности
## [1.0.0] - 2024-01-15
### Added
- Первый релиз
### Fixed
- Исправлена критическая ошибка аутентификации
Проходит ли эту проверку ваш репозиторий?
Бесплатно для публичных репозиториев GitHub, без регистрации. До 58 проверок DevOps и безопасности примерно за 5 секунд.