MAINT: Update agent instructions and add AGENTS.md/CLAUDE.md pointers#103
Merged
Conversation
…actoring Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot code review only ingests .github/copilot-instructions.md and cannot follow references, while Claude Code, Codex-family agents, and Copilot coding agent are interactive and can; keep the full content in the one place the pointer-incapable consumer reads, with one-line pointers for everyone else. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes the repository’s AI-agent guidance and makes the canonical Copilot instructions discoverable to other agent tools, while keeping .github/copilot-instructions.md as the single source of truth.
Changes:
- Expanded
.github/copilot-instructions.mdwith architecture/performance invariants (point-eval contract, workspace/thread-safety, allocation expectations, sparse/dense dispatch, out-of-domain pitfalls) and updated repo/testing/benchmark notes. - Updated the quick-start example to keep next-state transitions within the approximation domain (using
clamp) to avoid extrapolation pitfalls. - Added root-level
AGENTS.mdandCLAUDE.mdas pointers for agents that don’t natively ingest Copilot’s instructions file.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
CLAUDE.md |
Adds a Claude Code-friendly pointer to the canonical instructions file. |
AGENTS.md |
Adds a cross-tool pointer to .github/copilot-instructions.md for other agents/editors. |
.github/copilot-instructions.md |
Updates/expands the canonical agent instructions, including architecture notes and a domain-safe quick-start example. |
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
Two related changes to the repository's AI-agent instructions:
1. Content update of
.github/copilot-instructions.md(last touched in #77, before the performance refactoring #92-#101):src/point_eval.jland its contract),point_eval.jlself-containment pending the Move the point-evaluation kernel (src/point_eval.jl) upstream to BasisMatrices.jl #94 upstreaming, non-thread-safety of workspaces/caches, allocation-free inner sweeps, the sparse/denseevaluate_policy!dispatch, and the out-of-domain next-state pitfall (cf. TST: Keep next states within the interpolation domain in test and benchmark models #97).src/point_eval.jl,benchmark/, four new test files),inner_solver=:foc/:brentin the algorithms section,SparseArraysin dependencies, PR title-prefix conventions, and the benchmark-table requirement for performance PRs.2. Make the instructions reachable by non-Copilot agents.
.github/copilot-instructions.mdis read natively only by Copilot; Claude Code readsCLAUDE.md, and Codex/Cursor-family agents read the cross-toolAGENTS.mdconvention. Per GitHub's documentation, Copilot code review — the one agent that ingests its instructions file without the ability to follow references — reads only.github/copilot-instructions.md, while all the other consumers are interactive agents that can chase a pointer. So the full content stays in the one place the pointer-incapable consumer requires, and:AGENTS.md(root): one-line pointer for Codex/Cursor/Zed-family agents (also read by Copilot coding agent).CLAUDE.md(root): imports the canonical file via Claude Code's@-reference, which inlines it automatically.No content is duplicated;
.github/copilot-instructions.mdremains the single file to edit.🤖 Generated with Claude Code (Claude Fable 5)