chore: track the agent context files and thin out the repo root#785
Conversation
AGENTS.md and CLAUDE.md were gitignored as "AI agent context (local only)". They carry architecture facts agents act on, so drift in them was invisible to review, unfixable by a pull request, and free to differ between clones: #698 found four wrong claims in CLAUDE.md that had survived months, and that fix could not go through a PR at all. The reason for hiding them no longer holds either, since the last 100 commits carry 119 Co-Authored-By: Claude trailers. Corrected in both before publishing: - Dropped a pointer to ../internal-docs, a private repo. Dead link for any external reader, and the guidance it pointed at is already inlined above it. - Both claimed the commit-msg hook enforces Conventional Commits. It enforces an issue reference, with a docs: exemption; Conventional Commits are enforced on the PR title by pr-title.yml. - AGENTS.md still sent readers to lib/config.ts for GAMES/UTILITIES, the same drift #698 recorded for CLAUDE.md. Root goes from 20 files to 17 even after adding those two: GitHub resolves the community-health files from .github/ exactly as from the root, with the same sidebar entries. SimLauncher.ico deliberately stays put; electron-builder copies it as an extra resource and window.ts resolves it differently for packaged and dev builds, which is real risk for one line of tidiness. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![stashpeak-review-bot[bot]](https://avatars.githubusercontent.com/in/4331802?s=60&v=4){kind=small}
There was a problem hiding this comment.
🤖 Review Bot
🏷 config 🕐 ~2-5 min 🐞 0 🔐 0 🧪 0 📏 0
The diff under review is a trivial .gitignore change that removes the ignore entries for AGENTS.md and CLAUDE.md and replaces them with an explanatory comment, so those two files become tracked. This is a non-behavioral, docs/config-only change with no runtime code touched and no interaction with the repo's process-spawn, kill, or IPC-contract rules. Verified against the actual repository state that AGENTS.md and CLAUDE.md are now tracked, consistent with the PR description.
Walkthrough (1 file)
| File | Note |
|---|---|
.gitignore |
Removes the ignore rules for AGENTS.md/CLAUDE.md and adds a comment explaining they are now intentionally tracked, so agent context docs go through normal review. |
Total: $0.0170 (plus subscription)
Full-lane cost
Review bot usage
| mode | engine | model | tokens in | tokens out | cost | time | comments |
|---|---|---|---|---|---|---|---|
| full | claude-code | claude (subscription) | 8 | 1908 | sub | 26426 ms | 0 |
| shadow | api | x-ai/grok-4.5 | 3200 | 1490 | $0.0151 | 26362 ms | 1 |
| shadow | api | deepseek/deepseek-v4-flash | 3004 | 452 | $0.0005 | 8246 ms | 0 |
| shadow | api | xiaomi/mimo-v2.5 | 3231 | 3115 | $0.0013 | 33327 ms | 0 |
| shadow | api | nvidia/nemotron-3-ultra-550b-a55b:free | 3068 | 989 | $0.0000 | 12400 ms | 0 |
| shadow-verify | api-agentic | nvidia/nemotron-3-ultra-550b-a55b:free | 29977 | 955 | $0.0000 | 46228 ms | 2 |
|
@codex review |
|
Codex Review: Didn't find any major issues. Keep them coming! Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
1 participant
Track the agent context files
AGENTS.mdandCLAUDE.mdwere gitignored under "AI agent context (local only)". They carry architecture facts that agents act on, which makes that the wrong shelf: drift in them is invisible to review, unfixable by a pull request, and free to differ between clones.That is not hypothetical. #698 recorded four wrong claims in
CLAUDE.mdthat had survived for months, and when I opened a PR to fix them the review bot pointed out the file was not in the diff and could not be. The corrections had to be applied to an untracked local copy.The original reason for hiding them has also expired: the last 100 commits carry 119
Co-Authored-By: Claudetrailers, so AI assistance is already visible to anyone who opens the history.Corrected before publishing
../internal-docs/...pointer from both.githooks/commit-msgenforces Conventional Commits. It enforces an issue reference (#N) with adocs:exemption; Conventional Commits are enforced on the PR title bypr-title.yml. Verified by reading the hookAGENTS.mdregistry pathslib/config.tsforGAMES/UTILITIES. They are insrc/shared/domain/registries.ts, and it isBUILT_IN_UTILITIES. Same drift #698 recorded forCLAUDE.mdAGENTS.mdadd-a-game recipeKNOWN_GAME_KEYSproperty, so the old two-step recipe cannot come backThin out the root
20 files in the root put the README a long scroll down.
CONTRIBUTING.md,CODE_OF_CONDUCT.mdandSECURITY.mdmove to.github/, which GitHub resolves exactly as it does the root: the Contributing / Code of conduct / Security entries in the sidebar are unchanged. README's three relative links are updated; the moved files contain no relative links of their own (checked).Net: 20 files to 17, even after adding the two agent files.
SimLauncher.icodeliberately stays.electron-builder.ymlcopies it as an extra resource andsrc/main/window.ts:145resolves it at runtime with different paths for packaged and dev builds. That is real breakage, only catchable by an installed smoke test, for one line of tidiness.Test plan
format:check·lint·typecheck·buildnpm run test(563 pass)git grep internal-docsover tracked files returns nothinggrepfor the three moved filenames repo-wide: only the README links, now updatedNo runtime code changed, so there is nothing to add to the 1.2.0 smoke test.
Closes #784