docs: add AGENTS.md and model-selection guidance#45
Open
felipebalbi wants to merge 3 commits into
Open
Conversation
Provide a single, agent-facing guide at the repository root that documents the workspace layout, the verified build/test/clippy/doc commands, the trait shape conventions used by both crates, the &mut T-only blanket-impl rule, the defmt feature contract, ACPI versus SBS scope, and the commit/PR conventions (including the mandatory Assisted-by trailer). Prepend a short pointer to .github/copilot-instructions.md so Copilot-configured environments discover AGENTS.md, while keeping copilot-instructions.md authoritative for commit-message and AI attribution rules. 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
There was a problem hiding this comment.
Pull request overview
Adds repository-specific guidance for AI coding agents and updates GitHub Copilot instructions to point to it, aiming to reduce repeated “repo re-discovery” and keep agent behavior aligned with existing CI/conventions.
Changes:
- Add a new root-level
AGENTS.mddescribing workspace layout, verified commands, conventions, and “what not to do”. - Update
.github/copilot-instructions.mdto referenceAGENTS.mdfor non–commit-message guidance. - Add “Model selection & cost discipline” guidance for agent usage.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| AGENTS.md | Introduces a comprehensive agent guide (commands, conventions, constraints, model-selection guidance). |
| .github/copilot-instructions.md | Adds a pointer to AGENTS.md while keeping commit-message/AI-attribution rules here. |
|
|
||
| ### Trait shape (mirrors `embedded-hal`) | ||
|
|
||
| Every functional trait family has the same five-piece anatomy: |
Comment on lines
+119
to
+123
| On stable, `cargo fmt --check` prints warnings ("unstable features are | ||
| only available in nightly channel") **and still exits 0**. CI installs | ||
| the nightly toolchain solely to run `cargo fmt --check`. If you reformat | ||
| imports locally, use `cargo +nightly fmt` so the import grouping/granularity | ||
| options actually take effect. |
Comment on lines
+246
to
+248
| - Don't break `cargo semver-checks`. Any change that alters a public | ||
| signature must be paired with a version bump in the corresponding | ||
| `Cargo.toml`; the CI semver job will fail otherwise. |
Comment on lines
+350
to
+352
| - **Line endings:** repository convention is **LF**. The local clone | ||
| has `core.autocrlf=false`; do not re-enable autocrlf and do not let | ||
| your editor rewrite files with CRLF. |
Comment on lines
+183
to
+185
| adding a new blanket impl. The macro is exported from both | ||
| `embedded-batteries::smart_battery` and | ||
| `embedded-batteries-async::smart_battery`. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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).