Conectar

Documentation Compliance Check

GGPromptsbyGGPrompts
•
122
•
Gestión de Contenido

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

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.

Características Principales

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

Casos de Uso

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