docs: add AGENTS.md and model-selection guidance#29
Open
felipebalbi wants to merge 2 commits into
Open
Conversation
Introduce a comprehensive AGENTS.md at the repository root that captures the workspace layout, the no_std / no-panic / MSRV / additive- features invariants, the workspace clippy contract, the local mirror of the CI gates (fmt, clippy, test, doc, msrv, deny, vet, machete, nostd), the commit and AI-attribution rules from CONTRIBUTING.md and copilot-instructions.md, dependency policy, per-pilot notes for the common assistants, a pitfalls table, and a quick-reference cheat sheet. Prepend a short pointer to .github/copilot-instructions.md so Copilot discovers AGENTS.md while keeping copilot-instructions.md authoritative for commit-message formatting and AI attribution. 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
felipebalbi
requested review from
RobertZ2011,
Copilot,
jerrysxie,
kurtjd and
tullom
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds repository-specific guidance for AI coding agents and points Copilot’s repo instructions to that broader guide.
Changes:
- Adds
AGENTS.mdwith workspace layout, invariants, commands, conventions, contribution guidance, and model/cost guidance. - Updates
.github/copilot-instructions.mdto referenceAGENTS.mdwhile preserving Copilot-specific commit and attribution rules.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
AGENTS.md |
Adds comprehensive AI-agent contributor guidance for the Rust workspace. |
.github/copilot-instructions.md |
Adds a pointer to AGENTS.md as the broader repository guide. |
| | `cargo deny check` fails on license | Pulled in a GPL/AGPL crate | Replace with a permissively-licensed alternative or stop using it. | | ||
| | `cargo vet` fails | New transitive dep without audit | Add an audit (`cargo vet certify ...`) or pick a different crate. | | ||
| | `cargo fmt --check` fails | Forgot to format | Run `cargo fmt`. | | ||
| | `nostd` workflow passes locally, fails in CI | Default features differ | Run `cargo check --target thumbv8m.main-none-eabihf --no-default-features --locked` to match. | |
Comment on lines
+100
to
+103
| APIs newer than 1.90 in `embedded-mcu-hal`, or newer than 1.85 in | ||
| `storage_bus`, without bumping the corresponding `rust-version` | ||
| *and* documenting why in `embedded-mcu-hal/src/lib.rs` (which today | ||
| calls out `u16::is_multiple_of` as the reason for 1.90). |
Comment on lines
+106
to
+107
| and `cargo vet`. The only allowed git source organization is | ||
| `embassy-rs` (see `deny.toml` → `[sources.allow-org]`). |
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).