Repository navigation
Conversation
Layer: 1-coding-standards
Layer: 1-coding-standards
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Our code standards lived in three sections of
AGENTS.md, which is agent context, so human contributors had no path to them. This moves them into a rootCODING_STANDARDS.mdwritten for contributors that agents also read, and points every other file at it instead of restating it.User-facing: none
CODING_STANDARDS.md(new, 134 lines). Every rule is one Must, Prefer or Avoid line with a one-line reason. A Must blocks a PR only where it hits an Important category inREVIEW.md. It leads with the rules no linter knows: saved and exported data stays readable, query templates, performance on large graphs, and the browser-support baseline. Then come the moved Principles, TypeScript and Comments sections, plus short Errors and untrusted input, Testing, React and Styling sections that link the area guides rather than repeat them. It has no formatting rules and nothing thelintblock invite.config.tsalready enforces.AGENTS.md: drops Code Quality Standards, Comments and TypeScript, and the two test rules in Core Rules. Adds one line telling agents to readCODING_STANDARDS.mdbefore writing or reviewing code.typescript.autoClosingTagsmoves to Core Rules. Reviews names the new file and passes it to reviewer sub-agents next toREVIEW.md.REVIEW.md: the Nit rule now points atCODING_STANDARDS.mdfor structure and style.CONTRIBUTING.md: one new "Coding standards" section. The rest is unchanged.CODING_STANDARDS.md.No rule was dropped. Two got stronger:
REVIEW.mdalready treats copying passes over them as Important.REVIEW.md. Other boundaries stay Prefer.Three rules have no lint rule behind them yet: module-level
functiondeclarations, unnecessaryany, and the 1000-line signal. They stay as prose. A later change that turns one into a lint rule deletes its line here in the same PR.Merge Danger
Door: two-way
Impact: docs
Agents lose the standards from
AGENTS.md. They now reach them through the pointer line and the Reviews section.Related
🤖 Written by an AI agent on my behalf.