Repository navigation
Description
GitHub Copilot reads .github/copilot-instructions.md for context when it reviews a pull request. This repo doesn't have one, so Copilot reviews every PR with no knowledge of the conventions that actually govern this codebase — and those conventions are unusually strict and unusually specific.
What Copilot is currently blind to
- TypeScript: the flat ban on
any, on suppressing error types in config, and on unjustifiedas unknown asdouble casts. - Mantine-first styling: no inline styles, no raw hex /
rgba()literals (use--inspector-*tokens), CSS classes only as a last resort behind component props and theme variants. - The
.withProps()rule — extract a named subcomponent constant whenever an inline Mantine element carries two or more static styling/layout/behavior props, single-use included — and its genuine exceptions (Box,Accordion, headless components likeTransition,data-*attributes, non-factory components). - The
libvsutilssplit, and that the coverageincludeis a whitelist, so a module placed outside the named directories silently escapes the gate. - Test placement (side-by-side for web,
__tests__/for the Node clients) and the ≥90% per-file gate on all four dimensions, plus thev8 ignorepolicy that forbids lowering it. renderWithMantinebeing mandatory — hand-rolling a bareMantineProviderreintroduces a real cross-test failure class.
A reviewer that doesn't know these produces noise (flagging things our conventions require) and misses the violations that matter.
The work
- Add
.github/copilot-instructions.mdas a review-focused distillation ofAGENTS.md— the rules a reviewer would cite against a diff, not the whole document. Deliberately exclude the board recipes and IDs, milestone/branch mechanics, release procedure, and the project tree: no reviewer cites those, and copying them doubles the maintenance surface. - Amend
AGENTS.md→ "Keep documentation files up to date" to require mirroring review-relevant changes into that file in the same PR, stating thatAGENTS.mdremains the source of truth and defining what counts as review-relevant.
The maintenance risk, stated plainly
There is no generation step and nothing that detects drift between the two files. The mirroring rule is the only thing keeping them in sync, and a stale mirror is worse than no mirror — Copilot would then review confidently against rules we no longer hold. If this drifts in practice, the follow-up is a CI check that fails when AGENTS.md's review-relevant sections change without a corresponding copilot-instructions.md change, which is why the rule is written as "same PR" rather than "eventually."
Activity
cliffhall commentedon Aug 1, 2026
Closed by #1866, merged to
v2/main. (Closing manually:Closes #Nonly auto-closes for PRs targeting the default branch, and v2 PRs targetv2/main.)