docs: add AGENTS.md and model-selection guidance#41
Open
felipebalbi wants to merge 2 commits into
Open
Conversation
Author an AGENTS.md at the repository root that documents the build,test, lint, doc, fuzz, deny, and MSRV commands actually used by.github/workflows/check.yml, the three independent cargo workspaces(libs, examples/rt685s, bootloader-tool), the bootloader memorylayout and prelude conventions for IMXRT6xx, code-style rules,git/commit policy (per-commit author identity, Assisted-by trailer,LF line endings), and a workflow checklist for AI agents.Fold in the existing .github/copilot-instructions.md content as asuperset and prepend a pointer note to that file so tools that lookfor it by name are redirected to the new authoritative location. 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,
jerrysxie,
kurtjd and
williampMSFT
There was a problem hiding this comment.
Pull request overview
Adds repository-specific operating guidance for AI coding agents by introducing a comprehensive AGENTS.md (as the single “superset” guide) and updating Copilot instructions to point to it, aiming to reduce repeated re-discovery of CI commands, workspace layout, and contribution conventions.
Changes:
- Add
AGENTS.mddocumenting repo structure, workspaces, CI-equivalent commands, and contribution/commit rules. - Add model-selection / cost-discipline guidance to
AGENTS.md. - Update
.github/copilot-instructions.mdto defer toAGENTS.mdas the authoritative reference.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
AGENTS.md |
New agent-oriented repo guide (layout, CI commands, conventions, model-selection guidance). |
.github/copilot-instructions.md |
Adds a pointer noting AGENTS.md is now authoritative. |
| # AGENTS.md | ||
|
|
||
| Operational guide for AI coding agents (GitHub Copilot, Claude, etc.) working in | ||
| the `openDevicePartnership/ec-slimloader` repository. This file is the |
Comment on lines
+143
to
+146
| # libs and examples use the same flag set: | ||
| # -F clippy::suspicious -D clippy::correctness -F clippy::perf -F clippy::style | ||
| # bootloader-tool uses -D for clippy::suspicious instead of -F. | ||
|
|
Comment on lines
+155
to
+157
| # from bootloader-tool/ (host target) | ||
| cargo clippy -- \ | ||
| -D clippy::suspicious -D clippy::correctness -F clippy::perf -F clippy::style |
Comment on lines
+199
to
+200
| `examples/rt685s/ci.sh` builds the workspace once with no extra features and | ||
| then once per feature from `(defmt, non-secure)`. |
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).