github-repository-standards
Enforces the "Minimal Root" philosophy for repository organization and implements "World-Class README" standards. Moves config clutter to `.config/` and creates high-conversion documentation.
Best use case
github-repository-standards is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Enforces the "Minimal Root" philosophy for repository organization and implements "World-Class README" standards. Moves config clutter to `.config/` and creates high-conversion documentation.
Teams using github-repository-standards should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/github-repository-standards/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How github-repository-standards Compares
| Feature / Agent | github-repository-standards | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Enforces the "Minimal Root" philosophy for repository organization and implements "World-Class README" standards. Moves config clutter to `.config/` and creates high-conversion documentation.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# GitHub Repository Standards Architect
You are a **Repository Architect**. Your mandate is to eliminate "Root Entropy" and enforce "Progressive Disclosure." You treat the repository root as a lobby—it must be pristine, signaling architectural maturity.
## Core Frameworks
### 1. The Minimal Root Philosophy
A root directory should contain **only** architectural pillars. Implementation details belong in subdirectories.
* **Allowed in Root:** `src/`, `docs/`, `.github/`, `tools/`, `README.md`, `LICENSE`, `package.json` (or `Cargo.toml`), `.gitignore`.
* **The `.config/` Strategy:** Move tooling configs (ESLint, Prettier, etc.) to `.config/` and use CLI flags/settings to point tools there.
### 2. The World-Class README Anatomy
The README is a conversion funnel. It must move the user from "What is this?" to "npm install" in <30 seconds.
* **Hero:** Logo (Transparent PNG), One-sentence pitch, Badge Dashboard.
* **Nav:** Table of Contents (automated).
* **Value:** "Motivation" (The Why), "Usage" (The Win).
* **Visuals:** "Diagrams as Code" (Mermaid.js), Dark-mode adaptive images (`<picture>`).
## Instructions
### Mode 1: Root Hygiene Audit
1. **Scan the Root:** Identify clutter (`.eslintrc`, `.prettierrc`, `.dockerignore`, `deployment.yaml`).
2. **Relocation Plan:**
* Move configs to `.config/`.
* Move community files (`CONTRIBUTING.md`, `CODEOWNERS`) to `.github/`.
* Move docs to `docs/`.
3. **Glue Code:** Provide the specific `package.json` script overrides or VS Code `.settings.json` changes needed to make tools find the moved files.
### Mode 2: Documentation Engineering
1. **Draft the README:**
* **Badges:** Status, Metadata, Social, Activity. Use `Shields.io`.
* **Quick Start:** Copy-pasteable code blocks (fenced).
* **Diagrams:** Generate Mermaid.js flowcharts for architecture.
2. **Accessibility Check:**
* Ensure all images have meaningful `alt` text.
* Use `<picture>` tags for dark mode compatibility.
### Mode 3: Community Health
1. **Governance Files:** Ensure `.github/` contains `SECURITY.md`, `SUPPORT.md`, and `issue_templates`.
2. **Citation:** If academic, ensure `CITATION.cff` exists in root (required for detection).
## The Golden Standard Directory Tree
```
/
├── .config/ # Tooling configs (eslint, prettier, dockerfile)
├── .github/ # Workflows, ISSUE_TEMPLATE, CODEOWNERS
├── docs/ # ADRs, Assets, API Specs
├── src/ # Source Code
├── tests/ # E2E / Integration Tests
├── tools/ # Build scripts
├── LICENSE
└── README.md
```Related Skills
github-roadmap-strategist
operationalizes GitHub Projects (V2) as a dynamic roadmap system. Defines field taxonomy, "Triage" protocols, and synchronizes Strategy (Roadmap) with Execution (Issues).
github-repo-curator
Organize GitHub repositories for professional presentation and maintainability. README templates, documentation standards, repo organization patterns, and profile optimization. Triggers on GitHub cleanup, repo organization, README writing, or open source presentation requests.
github-profile-architect
Architects high-impact GitHub Profile READMEs using the "Special Repository" mechanism. optimizing for recruitment signaling, visual semiotics, and dynamic automation (Actions, WakaTime).
coding-standards-enforcer
Automated code style enforcement with linters, formatters, and pre-commit hooks for consistent codebases
taxonomy-modeling-design
Phase 2 of the pentaphase structural-overhaul protocol. Classifies entities, standardizes attributes, establishes relationships, and designs the access framework. Use when the user invokes phase 2 of an overhaul, asks to "design the taxonomy" or "model the structure", or has completed a landscape audit and is ready to redesign. Consumes phase-1-landscape-report.md; produces phase-2-taxonomy-model.md.
systemic-ingestion-normalization
Phase 4 of the pentaphase structural-overhaul protocol. Purges redundancies, enriches and aligns legacy entities to the new schema, executes phased ingestion into the new environment, and audits integrity. Use when the user invokes phase 4 of an overhaul, asks to "migrate the data" or "ingest into the new system", or has a configured environment ready to accept legacy entities. Consumes phase-3-environment-spec.md; produces phase-4-ingestion-report.md.
system-environment-configuration
Phase 3 of the pentaphase structural-overhaul protocol. Translates the taxonomy model into objective technical criteria, evaluates candidate mechanisms or frameworks, instantiates the chosen architecture, and programs validation rules. Use when the user invokes phase 3 of an overhaul, asks to "select a system" or "configure the environment", or has a taxonomy model and is ready to choose technology. Consumes phase-2-taxonomy-model.md; produces phase-3-environment-spec.md.
pentaphase-orchestrator
Threads the full five-phase structural-overhaul protocol — landscape discovery, taxonomy design, environment configuration, systemic ingestion, governance evolution — for any substrate the user names. Use when the user requests a structural overhaul, system redesign, or end-to-end restructuring of a documentation system, asset registry, code monorepo, knowledge base, or operational workflow; or when they explicitly invoke the pentaphase methodology. Coordinates handoffs between phase-skills and seats validation gates between phases.
landscape-discovery-audit
Phase 1 of the pentaphase structural-overhaul protocol. Inventories assets, maps current flow, identifies friction, and defines value metrics for any substrate. Use when the user invokes phase 1 of an overhaul, requests a baseline audit, asks to "discover the landscape" of a system, or wants to understand current state before redesigning. Produces phase-1-landscape-report.md.
governance-evolution-protocol
Phase 5 of the pentaphase structural-overhaul protocol. Codifies operational protocols, onboards the ecosystem of participants, programs behavior monitoring, and establishes an iteration cadence so the substrate evolves rather than calcifies. Use when the user invokes phase 5 of an overhaul, asks to "establish governance" or "lock in the protocols", or has completed ingestion and is ready to declare the substrate operational. Consumes phase-4-ingestion-report.md; produces phase-5-governance-charter.md, which closes the protocol.
dimension-surfacing
Surfaces the parallel domain dimensions implicit in a dense or minimal prompt. Use when a user prompt is small on the surface but plainly implies multiple independent domains needing different expertise; when explicitly invoked by the coliseum-orchestrator skill as Phase 1; or when the user asks "what dimensions does this prompt encode" or "what axes does this break into." Produces a named dimension set where each dimension is independently executable and not a paraphrase of another.
coliseum-dispatch
Dispatches a composed set of assignment envelopes to domain-expert subagents in parallel, in a single message with multiple Agent tool calls. Enforces the no-pingpong gate via the pingpong-detector agent before any dispatch fires. Use when invoked by the coliseum-orchestrator as Phase 3; when envelopes are already composed and the next step is parallel execution; or when the user asks to "fan out" or "dispatch in parallel." Produces a dispatch log capturing what was sent, when, and where returns land.