Update and maintain core repository documentation files (README.md, CHANGELOG.md, LICENSE, CONTRIBUTING.md) before commits or releases. Use when users need to update documentation to reflect code changes, prepare for releases, or ensure documentation consistency.
This skill helps update core repository documentation files before committing changes or creating releases.
Use this skill when:
Primary documentation file covering:
Common updates:
Chronological record of changes following Keep a Changelog format.
Structure:
# Changelog
## [Unreleased]
### Added
- New features not yet released
### Changed
- Changes to existing functionality
### Fixed
- Bug fixes
## [X.Y.Z] - YYYY-MM-DD
### Added
- Feature descriptions
### Changed
- Modification descriptions
### Fixed
- Bug fix descriptions
Common updates:
Legal terms for code usage and distribution.
Common updates:
Guidelines for contributors.
Typical sections:
Common updates:
When preparing a release:
Review changes since last release
Update CHANGELOG.md
[X.Y.Z] - YYYY-MM-DDUpdate README.md if needed
Update LICENSE if needed
Review CONTRIBUTING.md
Before committing changes:
Identify documentation impact
Update CHANGELOG.md Unreleased section
Update README.md if needed
Generate updated documentation files directly in /mnt/user-data/outputs/ with: