Where are the results of the check stored?

The skill writes a detailed report to .checkpoints/docs-check.json, including timestamps, file change status, and pass/fail metrics.

How does the skill distinguish between code and documentation changes?

It uses file extension and path filtering, treating Markdown, text, and specific configuration directories as documentation-only changes while flagging other files as code.

Why should I use this instead of manual checks?

Automating this process removes human error and ensures that documentation is never an afterthought, maintaining a high-quality audit trail for your project history.

What happens if I make a code change that doesn't need a changelog entry?

You can bypass the check by applying a 'no-changelog' label to the associated issue, which the skill detects to allow a PASS status for internal refactors.

Documentation Compliance Check

Name: Documentation Compliance Check
Author: GGPrompts

byGGPrompts

•

122

Content Management

Automates documentation hygiene by verifying that user-facing code changes include corresponding changelog updates or explicit bypass labels.

About

The Documentation Compliance Check skill streamlines the release process by ensuring that no user-facing code change goes undocumented. It analyzes your git diff to distinguish between pure documentation updates and functional code changes, enforcing a strict requirement for either a CHANGELOG.md update or an authorized 'no-changelog' bypass label. By automating this verification and logging results to a structured checkpoint file, it helps development teams maintain high documentation standards and reduces the risk of undocumented releases during fast-paced development cycles.

Key Features

Validation of CHANGELOG.md updates for all non-trivial modifications
Automated detection of code changes vs. documentation-only updates
Seamless git integration to compare local changes against main
Structured JSON checkpoint reporting for audit trails
122 GitHub stars
Support for 'no-changelog' bypass labels for internal refactors

Use Cases

Automating documentation checks during the pull request workflow
Maintaining project hygiene by forcing explicit decisions on documentation
Pre-release verification to ensure all features are captured in the changelog

About

Key Features

Validation of CHANGELOG.md updates for all non-trivial modifications
Automated detection of code changes vs. documentation-only updates
Seamless git integration to compare local changes against main
Structured JSON checkpoint reporting for audit trails
122 GitHub stars
Support for 'no-changelog' bypass labels for internal refactors

Use Cases

Automating documentation checks during the pull request workflow
Maintaining project hygiene by forcing explicit decisions on documentation
Pre-release verification to ensure all features are captured in the changelog