Skip to content

chore: Add CLAUDE.md - #7973

Draft
Rathoz wants to merge 3 commits into
mainfrom
chore/claude-md
Draft

chore: Add CLAUDE.md#7973
Rathoz wants to merge 3 commits into
mainfrom
chore/claude-md

Conversation

@Rathoz

@Rathoz Rathoz commented Aug 17, 2026

Copy link
Copy Markdown
Member

What

Adds a CLAUDE.md so Claude Code sessions check what a machine actually has before running repository commands, rather than assuming a toolchain is present. A native setup and the devcontainer are treated as equals — contributors install natively too, which is straightforward on Linux, where the devcontainer mostly earns its keep on macOS.

If neither is available it is told to say so, rather than skip a check or report it as passing, and to name which setup produced a result when that is not obvious.

Also records a few things that are easy to get wrong from the outside: lint:js runs eslint --fix and edits files, snapshots are CI's to update, and deploy.py writes to the live wiki when LUA_DEV_ENV_NAME is unset.

How it was tested

Not executable, so nothing to run. The commands it lists are the ones exercised in #7955: npm run lua-test, luacheck, npm run lint:scss, npm run lint:js, ruff check/format --check, and npm run build, all verified inside the container there.

@Rathoz
Rathoz requested review from a team as code owners August 17, 2026 11:16
@Rathoz Rathoz changed the title chore: Add CLAUDE.md pointing tooling at the devcontainer chore: Add CLAUDE.md Aug 17, 2026
@Rathoz
Rathoz marked this pull request as draft August 17, 2026 11:28
@ElectricalBoy ElectricalBoy added the qol Developer quality-of-life changes that are not deployed to wiki label Aug 18, 2026
@Rathoz
Rathoz force-pushed the feat/devcontainer branch 2 times, most recently from 4998a86 to e884b19 Compare August 20, 2026 08:28
Base automatically changed from feat/devcontainer to main August 21, 2026 06:37
Rathoz added 3 commits August 21, 2026 13:53
Claude Code sessions default to whatever is on the host, which for this
repository is usually a partial toolchain: lua may be a different
version, and busted or luacheck may be missing entirely, so results do
not say much about what CI will do. Points it at the devcontainer
instead, and tells it to stop rather than fall back to the host when
docker is unavailable.

Also records the things that are easy to get wrong from the outside:
that lint:js edits files, that snapshots are CI's to update, and that
deploy.py writes to the live wiki without LUA_DEV_ENV_NAME.
Refusing to run anything without docker is stricter than it needs to be,
since a complete host toolchain gives a usable answer. Allows the
fallback, on the conditions that the tool is confirmed present rather
than assumed, and that the result says which environment produced it, so
a host result is not mistaken for a container one.
The previous wording made the devcontainer the canonical setup and the
host a fallback, which is not how this repository works. Contributors
install the toolchain natively too, which is straightforward on linux,
where the devcontainer mostly earns its keep on macos and its deprecated
lua@5.1 formula.

Asks it to check what the machine has instead, run there, and keep the
part that matters, that a result names the setup it came from.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

qol Developer quality-of-life changes that are not deployed to wiki

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants