Repository navigation
Conversation
AGENTS.md tells coding agents where code goes, what consumers rely on, and which checks to run. scripts/check-conventions.mjs rejects code comments and em dashes in added lines, and runs on pull requests. eslint-config-scratch's require-jsdoc rule contradicted the no-comments rule, so it is off.
…t AGENTS.md details The conventions check now reads deleted files, compares comment text instead of whole lines, skips JSX text and allows em dashes on moved lines. require-jsdoc is also off in src/.eslintrc.js, which is a root config the top-level setting never reached.
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.
Adds
AGENTS.md, a short guide for coding agents working in this repo. It covers where code goes, what other packages and extensions rely on, and which checks to run.scripts/check-conventions.mjsenforces two MistWarp rules that were only checked in review: no code comments and no em dashes in added lines. It uses TypeScript's parser, sotypescriptis now a dev dependency, and it runs on pull requests. Tool directives are allowed, and so are comments that move along with their code.require-jsdocis off, because it contradicted the no-comments rule.There is no change to behaviour.
The check passes on this branch, and an independent review checked every claim in
AGENTS.mdagainst the code.