docs: add AGENTS.md and model-selection guidance#26
Open
felipebalbi wants to merge 2 commits into
Open
Conversation
Adds a comprehensive AGENTS.md at the repo root with project conventions, build/test commands, and code-style guidance distilled from CI workflows and existing source. Updates copilot-instructions.md with a leading note directing agents to AGENTS.md as the canonical source, avoiding drift between the two files. Assisted-by: GitHub Copilot:claude-opus-4.7
Adds guidance on choosing between premium and cheap models for code-assistant work, including escalation/de-escalation triggers, sub-agent routing defaults, /fleet rules, and session-hygiene tips. Keeps premium reasoning for genuinely hard problems and routes mechanical work to cheaper models. Assisted-by: GitHub Copilot:claude-opus-4.7
There was a problem hiding this comment.
Pull request overview
Adds repository-specific “agent onboarding” documentation so AI coding assistants (and humans) can quickly align on build/test commands, CI expectations, and contribution conventions without re-deriving them from the codebase.
Changes:
- Add a new root
AGENTS.mdcontaining project overview, repo layout, verified CI-aligned commands, and conventions. - Update
.github/copilot-instructions.mdto explicitly defer toAGENTS.mdas the canonical guidance. - Add a “Model selection & cost discipline” section to help control agent/model usage and cost.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| AGENTS.md | New canonical agent guidance (project facts, commands, conventions, and model-selection guidance). |
| .github/copilot-instructions.md | Adds a minimal pointer directing agents to read AGENTS.md first. |
Comment on lines
+23
to
+25
| - MSRV enforced in CI: **Rust 1.85** (see `.github/workflows/check.yml` | ||
| `msrv` job). The README still says `1.81`; treat the CI value as | ||
| authoritative until the README is fixed. |
Comment on lines
+290
to
+291
| The following is the full content of `.github/copilot-instructions.md` at | ||
| the time of writing, kept here so this file is a strict superset: |
Comment on lines
+52
to
+53
| └── src/ | ||
| └── lib.rs ← entire driver + unit tests (#[cfg(test)]) |
Comment on lines
+376
to
+379
| | Sub-agent type | Default model | Override to | | ||
| |-------------------|---------------------------|-------------------------------------------------| | ||
| | `explore` | cheap | keep cheap (`claude-haiku-4.5` or `gpt-5-mini`) | | ||
| | `task` (run cmd) | cheap | keep cheap | |
Comment on lines
+258
to
+259
| - See `.github/copilot-instructions.md` for the canonical AI-attribution | ||
| wording. |
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.
This PR adds an
AGENTS.mdfile (see agents.md) tailored to this repository, distilled from the project's CI workflows, configuration, source layout, and conventions. The goal is to give any AI coding agent (Copilot, Claude, Cursor, etc.) enough repo-specific context to be immediately productive without re-deriving conventions from scratch.Commit 1 —
docs: add AGENTS.md ...AGENTS.mdwith project overview, build/test/lint/fmt commands, code layout, contribution patterns, and any quirks observed (e.g.,defmtfeature constraints, nightly-onlyrustfmt.tomloptions, workspace layout)..github/copilot-instructions.mdupdated to point atAGENTS.mdas the authoritative source, so Copilot-specific configuration does not drift out of sync with the broader agent guidance. Where nocopilot-instructions.mdexisted, a minimal pointer file was added.Commit 2 —
docs(AGENTS.md): add model selection & cost discipline section/fleetrules, and session-hygiene tips. The aim is to keep premium reasoning for genuinely hard work and route mechanical edits to cheaper models, reducing wasted spend without sacrificing quality.No source code, dependencies, or CI behavior is changed by this PR — it is documentation only.
Marked as draft for review; happy to iterate on tone, scope, or any repo-specific detail that should be tightened up.
Assisted by GitHub Copilot (Claude Opus 4.7).