agentleFS
boyingliu01boyingliu01/xp-gate/docs/AGENTS.md

xp-gate

AGENTS.md4 starsChanged 6 months agoMITView on GitHub

Generated: 2026-11-04 Commit: eb2097b0 Branch: sprint/2026-11-03-02 Version: 0.37.0.0

The file

We split this AGENTS.md into the rules it gives an agent

5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Approved design docs feed specification.yaml: only APPROVED plans are auto-merged into the requirements file at the repo root.

    line 67
  2. Distinctive:

    Do NOT mix code and documentation changes in one commit.

    line 71
  3. Very specific:

    Do NOT create docs-only commits that bypass the gate suite by being all *.md.

    line 72
  4. Very specific:

    Do NOT re-introduce skill validation/evaluation/certification docs — out of scope per issue #140 (see CHANGELOG v0.7.2).

    line 73
  5. Very specific:

    Do NOT delete or rename a plan doc after it's been Delphi-APPROVED.

    line 74

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “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
AGENTS.md

DOCUMENTATION KNOWLEDGE BASE

Generated: 2026-11-04 Commit: eb2097b0 Branch: sprint/2026-11-03-02 Version: 0.37.0.0

OVERVIEW

Reference guides, design history, postmortems, and weekly retros. 30+ chronologically-archived design plans under plans/. Plan docs follow YYYY-MM-DD-topic.md and each typically corresponds to a Delphi consensus report or implementation plan.

STRUCTURE

docs/
├── plans/                # 30+ design docs (YYYY-MM-DD-topic.md format)
│   ├── 2026-04-05-*.md   # XP 12 practices, Delphi consensus
│   ├── 2026-04-09-*.md   # v0.0.2 architecture + implementation
│   ├── 2026-04-12-clean-code-solid-checker-design.md
│   ├── 2026-04-13-quality-gate-enhancement-design.md
│   ├── 2026-04-14-specification-generator-update-mode-design{,-v2}.md
│   ├── 2026-04-25-unified-boy-scout-design.md
│   ├── 2026-04-27-quality-gates-refactor.md
│   ├── 2026-05-04-mutation-testing-gate10.md
│   ├── 2026-05-04-sprint-flow-phase3-delphi.md
│   ├── 2026-05-04-sprint-flow-web-frontend.md
│   ├── 2026-05-16-gate8-mutation-testing-precommit.md
│   ├── 2026-05-17-web-dashboard.md
│   ├── 2026-05-19-xp-gate-zero-install-{design,specification.yaml,consensus-report}.md
│   ├── 2026-05-29-xp-gate-cross-platform-plugin-{design,implementation-plan}.md
│   ├── 2026-05-29-specification-fix-issues.yaml
│   ├── 2026-05-30-xp-gate-uninstall-design.md
│   ├── 2026-05-31-issue-79-ui-sprint-detection-design.md
│   ├── 2026-06-02-issue-78-mock-layering-strategy.md
│   ├── 2026-06-04-skill-version-sync-design.md
│   └── 2026-06-06-sprint-branch-cleanup-design.md
├── incidents/            # Postmortems
├── retros/               # Weekly engineering retrospectives
├── admin-template-guidelines.md
├── gate-validation-guide.md
├── MULTI-MODEL-REVIEW-GUIDE.md
├── performance-benchmark.md
├── principlesrc-configuration.md
├── ralph-loop-design.md
├── rename-guide.md
├── specification-ahe-observability.yaml
└── sprint-fix-open-issues-design.md

WHERE TO LOOK

TaskLocation
Design historyplans/ (sorted chronologically; oldest = 2026-04, newest = 2026-06)
Gate validation guidegate-validation-guide.md
Multi-model review processMULTI-MODEL-REVIEW-GUIDE.md
Performance benchmark dataperformance-benchmark.md
Principles config referenceprinciplesrc-configuration.md
Ralph-loop designralph-loop-design.md
Mock-layering designplans/2026-06-02-issue-78-mock-layering-strategy.md
UI sprint detectionplans/2026-05-31-issue-79-ui-sprint-detection-design.md
Skill version syncplans/2026-06-04-skill-version-sync-design.md
Sprint-branch cleanupplans/2026-06-06-sprint-branch-cleanup-design.md
Past incidentsincidents/
Weekly retrosretros/

CONVENTIONS

  • Plan doc filename: strict YYYY-MM-DD-topic.md. Date = the day the design was approved or filed, not the day code shipped.
  • One topic = one file. Major revisions get a -v2, -v3 suffix; never overwrite history.
  • Approved design docs feed specification.yaml: only APPROVED plans are auto-merged into the requirements file at the repo root.
  • Plans are immutable once Delphi-APPROVED. Corrections happen in a new -v2 file.

ANTI-PATTERNS (THIS PROJECT)

  • Do NOT mix code and documentation changes in one commit. Hooks may pass but reviewers will reject.
  • Do NOT create docs-only commits that bypass the gate suite by being all *.md. (Gate 0 still runs.)
  • Do NOT re-introduce skill validation/evaluation/certification docs — out of scope per issue #140 (see CHANGELOG v0.7.2). XP-Gate's responsibility for skills is packaging / install / update / uninstall / distribution / runtime invocation only.
  • Do NOT delete or rename a plan doc after it's been Delphi-APPROVED. Supersede with -v2.

NOTES

  • Plan docs frequently link to one or more .code-walkthrough-result.json snapshots stored under .xp-gate/reports/ in the implementation PR.
  • Skill validation/evaluation/certification docs were removed in issue #140 (see CHANGELOG.md v0.7.2). XP-Gate's skill scope is packaging/install/update/uninstall/distribution/runtime invocation only.
  • The two newest plans (2026-06-02-issue-78-mock-layering-strategy.md and 2026-06-06-sprint-branch-cleanup-design.md) correspond to the work that shipped in v0.8.x.

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.