RL001: HasChangelog

Overview

Property Value
ID RL001
Name HasChangelog
Group release
Severity WARNING

Description

Checks for a changelog file documenting version history.

A changelog helps users understand:

  • What changed in each version
  • Breaking changes to watch for
  • New features and bug fixes

What it checks

The check looks for any of these files:

  • CHANGELOG.md, CHANGELOG.rst, CHANGELOG.txt, CHANGELOG
  • CHANGES.md, CHANGES.rst, CHANGES.txt, CHANGES
  • NEWS.md, NEWS.rst, NEWS.txt, NEWS
  • HISTORY.md, HISTORY.rst, HISTORY.txt, HISTORY

How to fix

Create a CHANGELOG.md file:

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/),
and this project adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

### Added
- New feature X

### Changed
- Updated behavior Y

### Fixed
- Bug fix Z

## [1.0.0] - 2024-01-15

### Added
- Initial release

Keep a Changelog format

The Keep a Changelog format uses these categories:

  • Added - New features
  • Changed - Changes to existing functionality
  • Deprecated - Features to be removed
  • Removed - Removed features
  • Fixed - Bug fixes
  • Security - Security fixes

Configuration

Skip this check

[tool.pycmdcheck]
skip = ["RL001"]

CLI

pycmdcheck --skip RL001