Conversation
Coding agents read repository instruction files automatically, so this gives them the conventions the repo already follows: the checks to run before pushing, jlpm-only frontend tooling (no packageManager pin, and lockfiles regenerated with jlpm), the seven-place admin policy checklist, and importing icons from src/icons.ts. CLAUDE.md imports AGENTS.md so there is one file to maintain, and CONTRIBUTING.md points to it next to the existing lockfile note.
An agent that hits a Prettier failure in lint:check may reformat by hand or reach for a global prettier. jlpm lint applies the repo's own formatter, including to Markdown.
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
Coding agents (Claude Code, Codex, Cursor, and others) now read repository instruction files automatically. This adds one for Notebook Intelligence so agents pick up conventions the repo already follows, most of which CONTRIBUTING.md and in-code comments describe for people.
Solution
AGENTS.mdholds the rules, in three short sections:pytest tests/ -q,jlpm tsc --noEmit,jlpm lint:check, andjlpm jest, plus a note to runjlpm lintto auto-fix formatting problems.jlpmfor frontend commands, leavepackageManagerout ofpackage.json, and regenerateyarn.lockwithjlpm installand confirmjlpm install --immutablepasses.FEATURE_POLICY_SPECinextension.pywhen adding an admin policy, and import icons fromsrc/icons.ts.CLAUDE.mdis a single@AGENTS.mdline, so Claude Code imports the same file and there is only one place to maintain.AGENTS.mdnext to its existing note about lockfile changes.The
packageManagernote explains the mechanism:jlpm(Yarn 3.5.0) ignores the field, but a lockfile written by a different Yarn version gets a different TypeScript builtin patch hash, and CI's immutable install rejects it withYN0028.Testing
prettier --checkpasses onAGENTS.md,CLAUDE.md, andCONTRIBUTING.md.jlpm --versionreports 3.5.0; thejupyterlab/maintainer-toolsbase-setup action only enables corepack whenpackageManageris present; CI runspytest tests/ -q,jlpm run lint:check, andjlpm test; theFEATURE_POLICY_SPECcomment lists the seven policy touchpoints; and no file undersrc/importsreact-iconsdirectly.Risks / follow-ups
None expected. The files only affect tools that read them, and more rules can be added as they prove useful.