repo-canon
Repository documentation, contribution, agent workflow, and GitHub validation standards
- Última versió
- v0.27.0, 12 de nov. del 2026
- Requereix
- CLI de Repo Standards ≥ 10.0.0
- Repositori
- github.com/
lutzseverino/ repo-canon
Adopta repo-canon
Dona el prompt al teu agent al repositori que vols configurar, o executa-hi tu mateix l'ordre. En tots dos casos tries una versió i un perfil, i no es fa cap commit fins que revises els canvis.
Qualsevol pot afegir-hi una font. Revisa-la abans d'adoptar-la.
Una configuració a punt per començar
Repo Canon és una configuració a punt per començar. El teu agent la instal·la al teu repositori i l'adapta al teu projecte, i més endavant el mateix prompt l'actualitza a una versió més nova.
AGENTS.md
Un AGENTS.md que els agents llegeixen primer, amb la documentació del projecte per a agents al costat, a docs/agents/.
-
AGENTS.md -
docs/agents/README.md -
docs/agents/domain.md -
docs/agents/issue-tracker.md -
docs/agents/project.md -
docs/agents/triage-labels.md
Skills per a agents
Skills a .agents/skills/ per a triatge, especificacions i tiquets, desenvolupament guiat per proves, revisió de codi i pull requests.
-
.agents/skills/babysit/ -
.agents/skills/code-review/ -
.agents/skills/codebase-design/ -
.agents/skills/create-adopted-repo/ -
.agents/skills/create-repository/ -
.agents/skills/diagnosing-bugs/ -
.agents/skills/domain-modeling/ -
.agents/skills/factory/ -
.agents/skills/grill-with-docs/ -
.agents/skills/grilling/ -
.agents/skills/implement/ -
.agents/skills/improve-codebase-architecture/ -
.agents/skills/orchestrate/ -
.agents/skills/pr/ -
.agents/skills/prototype/ -
.agents/skills/research/ -
.agents/skills/review/ -
.agents/skills/tdd/ -
.agents/skills/to-spec/ -
.agents/skills/to-tickets/ -
.agents/skills/triage/ -
.agents/skills/wayfinder/ -
.agents/skills/writing-for-agents/
Guia de contribució
Un CONTRIBUTING.md per a les persones i els agents que treballen al repositori.
-
CONTRIBUTING.md
Plantilles d'issues i de PR
Formularis d'issues de GitHub per a informes d'errors, sol·licituds de funcionalitats, especificacions i tiquets d'implementació, i una plantilla de pull request.
-
.github/ISSUE_TEMPLATE/bug-report.yml -
.github/ISSUE_TEMPLATE/feature-request.yml -
.github/ISSUE_TEMPLATE/implementation-ticket.yml -
.github/ISSUE_TEMPLATE/specification.yml -
.github/PULL_REQUEST_TEMPLATE.md
Comprovacions
Comprovacions de la navegació de la documentació, l'estructura dels README i el fitxer de revisors de pull requests, que s'executen en adoptar i amb repo-standards check, i fluxos de treball de GitHub Actions, entre els quals comprovacions dels contractes d'issues i de les metadades de les pull requests.
-
.github/workflows/issue-contracts.yml -
.github/workflows/pr-metadata.yml -
.github/workflows/sandbox-image.yml -
.github/workflows/standards-update.yml -
documentation-navigation -
factory-model-policy -
factory-review-policy -
project-readme-structure -
pull-request-reviewer -
repository-readme-structure -
required-checks -
typescript-astro-stack-manifests -
typescript-node-stack-manifests -
typescript-vite-stack-manifests
Perfils
- standard
- The Repo Canon standards for every adopting repository
- factory
- The standard profile plus the factory's repository files and workflow rules, for a repository a factory serves
- workbench
- Only the workflow skills, with the files they need to run and their license notices, for the orchestrating agent's workbench
Què instal·la
Cada declaració del seu standards.yaml a v0.27.0, amb els camins que instal·la o gestiona i les comprovacions que executa.
| Declaració | Instal·la o gestiona | Comprovacions | Perfils |
|---|---|---|---|
agent-configuration-index Fitxer | docs/agents/README.md | standard, factory | |
agent-guidance Fitxer | AGENTS.md | standard, factory | |
bug-report-template Fitxer | .github/ISSUE_TEMPLATE/bug-report.yml | standard, factory | |
comments Pautes del repositori | Camins que troba a cada projecte | standard, factory | |
contribution-guidance Fitxer | CONTRIBUTING.md | standard, factory | |
documentation Pautes del repositori | Camins que troba a cada projecte | documentation-navigation | standard, factory |
domain-configuration Fitxer | docs/agents/domain.md | standard, factory | |
factory-configuration Fitxer | .scriptorium/config.json | factory | |
factory-sandbox-image Pautes del repositori | .scriptorium/Dockerfile.factory/Dockerfile.factory/config.json | factory | |
factory-sandbox-image-workflow Fitxer | .github/workflows/sandbox-image.yml | factory | |
factory-workflow Pautes del repositori | Camins que troba a cada projecte | factory-model-policy | factory |
feature-request-template Fitxer | .github/ISSUE_TEMPLATE/feature-request.yml | standard, factory | |
git-attributes Fitxer | .gitattributes | standard, factory | |
github-repository-configuration Pautes del repositori | Camins que troba a cada projecte | required-checkspull-request-reviewerfactory-review-policy | standard, factory |
github-validator-trigger Fitxer | .github/scripts/validate.mjs | standard, factory | |
humanlayer-skills-license Fitxer | .agents/skills/LICENSE.humanlayer-skills | Tots | |
implementation-ticket-template Fitxer | .github/ISSUE_TEMPLATE/implementation-ticket.yml | standard, factory | |
issue-contract-cutoff Fitxer | scripts/issue-contract-cutoff.mjs | standard, factory | |
issue-contract-sources Fitxer | scripts/issue-contract-sources.mjs | Tots | |
issue-contract-store Fitxer | scripts/issue-contract-store.mjs | Tots | |
issue-contract-validator Fitxer | vendor/repo-canon/validate-issue-contract.mjs | Tots | |
issue-contract-workflow Fitxer | .github/workflows/issue-contracts.yml | standard, factory | |
issue-tracker-configuration Fitxer | docs/agents/issue-tracker.md | standard, factory | |
marked-license Fitxer | vendor/marked/LICENSE | Tots | |
marked-parser Fitxer | vendor/marked/marked.esm.js | Tots | |
marked-provenance Fitxer | vendor/marked/README.md | Tots | |
mattpocock-skills-license Fitxer | .agents/skills/LICENSE.mattpocock-skills | Tots | |
parse5-entities-license Fitxer | vendor/parse5/LICENSE.entities | Tots | |
parse5-license Fitxer | vendor/parse5/LICENSE.parse5 | Tots | |
parse5-parser Fitxer | vendor/parse5/parse5.esm.js | Tots | |
parse5-provenance Fitxer | vendor/parse5/README.md | Tots | |
postern-bundle Fitxer | vendor/postern/postern.mjs | Tots | |
postern-license Fitxer | vendor/postern/LICENSE | Tots | |
postern-provenance Fitxer | vendor/postern/README.md | Tots | |
pr-metadata-validator Fitxer | .github/scripts/validate-pr-metadata.mjs | standard, factory | |
pr-metadata-workflow Fitxer | .github/workflows/pr-metadata.yml | standard, factory | |
project-agent-guidance Fitxer | docs/agents/project.md | standard, factory | |
project-readmes Pautes del repositori | Camins que troba a cada projecte | project-readme-structure | standard, factory |
pull-request-template Fitxer | .github/PULL_REQUEST_TEMPLATE.md | standard, factory | |
rendered-markdown-runtime Fitxer | operations/lib/rendered-markdown.mjs | Tots | |
repository-license Fitxer | LICENSE | standard, factory | |
repository-readme Fitxer | README.md | repository-readme-structure | standard, factory |
skill-babysit Skill | .agents/skills/babysit/ | Tots | |
skill-code-review Skill | .agents/skills/code-review/ | Tots | |
skill-codebase-design Skill | .agents/skills/codebase-design/ | Tots | |
skill-create-adopted-repo Skill | .agents/skills/create-adopted-repo/ | workbench | |
skill-create-repository Skill | .agents/skills/create-repository/ | workbench | |
skill-diagnosing-bugs Skill | .agents/skills/diagnosing-bugs/ | Tots | |
skill-domain-modeling Skill | .agents/skills/domain-modeling/ | Tots | |
skill-factory Skill | .agents/skills/factory/ | factory | |
skill-grill-with-docs Skill | .agents/skills/grill-with-docs/ | Tots | |
skill-grilling Skill | .agents/skills/grilling/ | Tots | |
skill-implement Skill | .agents/skills/implement/ | Tots | |
skill-improve-codebase-architecture Skill | .agents/skills/improve-codebase-architecture/ | Tots | |
skill-orchestrate Skill | .agents/skills/orchestrate/ | workbench | |
skill-pr Skill | .agents/skills/pr/ | Tots | |
skill-prototype Skill | .agents/skills/prototype/ | Tots | |
skill-research Skill | .agents/skills/research/ | Tots | |
skill-review Skill | .agents/skills/review/ | Tots | |
skill-tdd Skill | .agents/skills/tdd/ | Tots | |
skill-to-spec Skill | .agents/skills/to-spec/ | Tots | |
skill-to-tickets Skill | .agents/skills/to-tickets/ | Tots | |
skill-triage Skill | .agents/skills/triage/ | Tots | |
skill-wayfinder Skill | .agents/skills/wayfinder/ | Tots | |
skill-writing-for-agents Skill | .agents/skills/writing-for-agents/ | Tots | |
specification-template Fitxer | .github/ISSUE_TEMPLATE/specification.yml | standard, factory | |
standards-update-workflow Fitxer | .github/workflows/standards-update.yml | standard, factory | |
triage-label-configuration Fitxer | docs/agents/triage-labels.md | standard, factory | |
typescript-astro-stack Pautes del repositori | Camins que troba a cada projecte | typescript-astro-stack-manifests | standard, factory |
typescript-node-stack Pautes del repositori | Camins que troba a cada projecte | typescript-node-stack-manifests | standard, factory |
typescript-vite-stack Pautes del repositori | Camins que troba a cada projecte | typescript-vite-stack-manifests | standard, factory |
validator-command Fitxer | vendor/repo-canon/validate.mjs | standard, factory |