agentleFS
Sign inStart free
alanbenalanben/ClaudeSkills/repo-docs/SKILL.md

repo-docs

Skill0 starsChanged 10 months agoMITView on GitHub

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.

16 other projects use a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

19 rules. 0 are common, 17 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 13 edited versions we read keep these.

  • 17

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill when:

    line 12
  2. Distinctive:

    Add new features or capabilities

    line 29
  3. Distinctive:

    Add or update examples

    line 32
  4. Distinctive:

    Add new version entry with date

    line 64
  5. Distinctive:

    Document new features, changes, and fixes

    line 65
  6. Distinctive:

    Add version comparison links at bottom

    line 66
  7. Distinctive:

    When preparing a release:

    line 94
  8. Distinctive:

    Check git log or PR history

    line 97
  9. Very specific:

    Create new version section: [X.Y.Z] - YYYY-MM-DD

    line 102
  10. Distinctive:

    Add version comparison link

    line 105
  11. Distinctive:

    Add new features to overview

    line 108
  12. Distinctive:

    Ensure workflow is current

    line 118
  13. Distinctive:

    Update any changed processes

    line 119
  14. Very specific:

    Add to appropriate category (Added/Changed/Fixed)

    line 132
  15. Distinctive:

    Keep CHANGELOG current: - Update with each change, not at release time

    line 143
  16. Distinctive:

    User perspective: - Document what users see, not internal refactoring

    line 145
  17. Distinctive:

    Version format: - Follow Semantic Versioning (MAJOR.MINOR.PATCH)

    line 146
  18. Distinctive:

    Date format: - Use ISO 8601 (YYYY-MM-DD)

    line 147
  19. Distinctive:

    Categorize correctly: - Use standard categories (Added, Changed, Fixed, etc.)

    line 148

“Common” is measured: kept by at least 6 in 10 of the 13 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Repository Documentation Updates

This skill helps update core repository documentation files before committing changes or creating releases.

When to Use This Skill

Use this skill when:

  • Preparing to commit changes and need to update documentation
  • Creating a release and need to update CHANGELOG
  • Documentation is out of sync with code changes
  • Need to add or update core repository files (README, CHANGELOG, LICENSE, CONTRIBUTING)

Core Documentation Files

README.md

Primary documentation file covering:

  • Project overview and purpose
  • Setup and installation instructions
  • Basic usage examples
  • Development guidelines
  • Links to additional documentation

Common updates:

  • Add new features or capabilities
  • Update installation steps
  • Revise configuration instructions
  • Add or update examples

CHANGELOG.md

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:

  • Move items from Unreleased to new version section
  • Add new version entry with date
  • Document new features, changes, and fixes
  • Add version comparison links at bottom

LICENSE

Legal terms for code usage and distribution.

Common updates:

  • Update copyright year
  • Change license type (requires project decision)
  • Update copyright holder

CONTRIBUTING.md

Guidelines for contributors.

Typical sections:

  • How to report issues
  • Development workflow
  • Code submission process
  • Testing requirements
  • Communication channels

Common updates:

  • Update workflow steps
  • Revise standards or requirements
  • Update contact information
  • Add new guidelines

Workflow for Release Preparation

When preparing a release:

  1. Review changes since last release
    • Check git log or PR history
    • Identify user-facing changes
    • Note breaking changes or deprecations
  2. Update CHANGELOG.md
    • Create new version section: [X.Y.Z] - YYYY-MM-DD
    • Move items from Unreleased to new version
    • Categorize: Added, Changed, Deprecated, Removed, Fixed, Security
    • Add version comparison link
  3. Update README.md if needed
    • Add new features to overview
    • Update version numbers
    • Revise examples if API changed
    • Update dependencies list
  4. Update LICENSE if needed
    • Update copyright year
    • Verify copyright holder
  5. Review CONTRIBUTING.md
    • Ensure workflow is current
    • Update any changed processes

Workflow for Regular Commits

Before committing changes:

  1. Identify documentation impact
    • Does change affect usage?
    • Are there new features?
    • Did configuration change?
    • Are there breaking changes?
  2. Update CHANGELOG.md Unreleased section
    • Add to appropriate category (Added/Changed/Fixed)
    • Be specific and user-focused
    • Note if breaking change
  3. Update README.md if needed
    • Add new features
    • Update examples
    • Revise configuration steps

Best Practices

  • Keep CHANGELOG current - Update with each change, not at release time
  • Be specific - "Added user authentication" not "Made improvements"
  • User perspective - Document what users see, not internal refactoring
  • Version format - Follow Semantic Versioning (MAJOR.MINOR.PATCH)
  • Date format - Use ISO 8601 (YYYY-MM-DD)
  • Categorize correctly - Use standard categories (Added, Changed, Fixed, etc.)
  • Link commits - Reference commit SHAs or PR numbers when helpful

Output Format

Generate updated documentation files directly in /mnt/user-data/outputs/ with:

  • Proper markdown formatting
  • Consistent structure
  • Current information
  • Clear, concise descriptions

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free