Skip to content

docs: rewrite CLAUDE.md and AGENTS.md to match actual repo state#65

Merged
jay9297 merged 3 commits into
devfrom
claude/claude-md-docs-ldxdux
Jun 11, 2026
Merged

docs: rewrite CLAUDE.md and AGENTS.md to match actual repo state#65
jay9297 merged 3 commits into
devfrom
claude/claude-md-docs-ldxdux

Conversation

@jay9297

@jay9297 jay9297 commented Jun 11, 2026

Copy link
Copy Markdown
Owner

Summary

Rewrites CLAUDE.md (and applies the same corrections to AGENTS.md) so the guidance given to AI assistants matches the repository as it actually is. The previous version had several commands and paths that no longer (or never) worked:

  • Test commands fixed — the compose service is busted-tests, not tests (docker compose run --rm tests fails). Added the CI-equivalent unit invocation (--exclude-tags builds,data), --filter for running a single test, and the caveat that --coverage can't write luacov.report.out through compose because the volume is mounted read-only (CI uses a separate docker run for this).
  • Paths fixed — there is no src/Modules/Calcs/ directory; the calc engine is the flat src/Modules/Calc*.lua files. ModParser tests live in spec/System/TestModParser_spec.lua (not TestModParser.lua). tests/ is a small Python test for fix_ascendancy_positions.py, not the Docker harness, so that claim was dropped.
  • New architecture section — entry points (Launch.lua vs HeadlessWrapper.lua), the modifier system (ModParsermod() syntax → ModDB/ModList), the calculation pipeline including the per-hand output/globalOutput/combineStat pass model from docs/calcOffence.md, the generated nature of src/Data/ via src/Export/, and pointers to the docs/ tutorials.
  • Testing baseline documented — 370 successes on dev plus the two known TestWard_spec.lua failures, so assistants don't "fix" them by weakening assertions.
  • Fork rules aligned between both files — never PR upstream, target jay9297/PathOfBuilding-PoE2 dev; noted the ai-fix/ai-review/auto-merge workflows. AGENTS.md keeps its push-default and upstream-sync rules.
  • code-review-graph MCP section made conditional — the server isn't configured in the repo (no .mcp.json), so both files now tell assistants to use those tools when available and fall back to standard tools otherwise, instead of unconditionally mandating tools that may not exist in a session.
  • Spellcheck — added inline cspell:ignore directives for callees and the lowercase GHCR image path, which aren't in the external dictionary.

https://claude.ai/code/session_01EitwohXyFktgKuxdvwgYHY

- Fix test commands: compose service is 'busted-tests', not 'tests';
  add --exclude-tags/--filter usage and the read-only-volume coverage caveat
- Fix paths: calc engine is flat src/Modules/Calc*.lua (no Calcs/ dir),
  ModParser tests live in spec/System/TestModParser_spec.lua
- Add architecture overview: entry points, modifier system (ModParser/
  ModDB/mod syntax), calculation pipeline incl. per-hand output passes,
  generated game data, and pointers to docs/
- Document CI matrix, 370-success baseline and known TestWard failures
- Carry over fork/PR rules from AGENTS.md; make the code-review-graph
  MCP section conditional on tool availability

https://claude.ai/code/session_01EitwohXyFktgKuxdvwgYHY
@github-actions

Copy link
Copy Markdown

🔄 Cycle 1, attempt 1/3
✅ Agent succeeded (cycle 1, attempt 1)

The spellcheck dictionary doesn't know 'callees' or the lowercase
GHCR image path components; the image name must stay lowercase, so
ignore them inline.

https://claude.ai/code/session_01EitwohXyFktgKuxdvwgYHY
@github-actions

Copy link
Copy Markdown

🔄 Cycle 1, attempt 1/3
✅ Agent succeeded (cycle 1, attempt 1)

Same fixes as the CLAUDE.md rewrite: correct compose service name
(busted-tests), correct test file names (TestModParser_spec.lua),
calc engine is flat src/Modules/Calc*.lua (no Calcs/ dir), drop the
inaccurate 'tests/ is the Docker harness' claim, add the coverage
read-only-volume caveat, test baseline, per-hand pass gotcha, and
make the code-review-graph MCP section conditional on availability.

https://claude.ai/code/session_01EitwohXyFktgKuxdvwgYHY
@jay9297 jay9297 changed the title docs: rewrite CLAUDE.md to match actual repo state docs: rewrite CLAUDE.md and AGENTS.md to match actual repo state Jun 11, 2026
@github-actions

Copy link
Copy Markdown

🔄 Cycle 1, attempt 1/3
✅ Agent succeeded (cycle 1, attempt 1)

@jay9297
jay9297 marked this pull request as ready for review June 11, 2026 02:46
@jay9297
jay9297 merged commit d4893bb into dev Jun 11, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants