Skills
.Work. You
Rest

github-readme-contract-sync

Community

Keep READMEs in sync with builds and runtimes.

Content & Communication#documentation#github#readme#contract#dev-setup#build-prerequisites#runtime-prerequisites
AuthorBSchafer01
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Maintains a public README that accurately reflects the current build, runtime, and installer contracts for an actively developed product.

Core Features & Use Cases

  • Enforces frontmatter-driven metadata to capture separate build prerequisites and installed-runtime prerequisites.
  • Documents dev-time content-loading seams that affect local README rendering, ensuring contributors see the correct guidance.
  • Promotes architecture, workflow, and caveats over marketing copy to improve transparency and trust.
  • Validates README content against source, tests, and validated build outputs, and clearly marks completed versus in-progress areas.

Quick Start

Create a public GitHub README that stays aligned with the live product contracts for builds, runtimes, and installers.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: github-readme-contract-sync
Download link: https://github.com/BSchafer01/PanelNester/archive/main.zip#github-readme-contract-sync

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.