docs: add AGENTS.md and model-selection guidance#865
Open
felipebalbi wants to merge 2 commits into
Open
Conversation
Introduce a top-level AGENTS.md as the canonical, agent-agnostic
briefing for AI coding tools working in this workspace. The file
mirrors and extends the existing Copilot instructions with:
* a project snapshot (targets, MSRV, runtime),
* a tour of the ~30 workspace member crates,
* the full set of build, test, lint, and doc commands that CI
runs in .github/workflows/check.yml,
* the Service<'hw> pattern, IPC primitives, and core utilities,
* coding conventions (no_std, mutually exclusive logging features,
workspace clippy lints, error handling, formatting),
* contribution rules including the mandatory Assisted-by trailer,
* a pre-commit checklist for agents.
Prepend a pointer note to .github/copilot-instructions.md so the
two documents stay discoverable from each other.
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
williampMSFT
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository-specific AGENTS.md briefing intended to let AI coding agents (and humans) quickly align with the workspace’s build/test commands, architecture patterns, and contribution rules, and updates Copilot instructions to point to that guidance.
Changes:
- Introduce
AGENTS.mdwith workspace snapshot, common commands, architecture/coding conventions, and contribution/CI notes. - Add a “Model selection & cost discipline” section to
AGENTS.md. - Update
.github/copilot-instructions.mdwith a pointer toAGENTS.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
AGENTS.md |
New agent briefing document with commands, conventions, CI/workflow references, and model-selection guidance. |
.github/copilot-instructions.md |
Adds an upfront note linking to AGENTS.md as a canonical briefing. |
Comment on lines
+12
to
+13
| > the authoritative behavioural contract; it is loaded into the GitHub | ||
| > Copilot context automatically. This file mirrors and extends it. |
|
|
||
| | Crate | Role | | ||
| |---|---| | ||
| | `embedded-service` | Core utilities: intrusive list, IPC primitives (`ipc::deferred`, `broadcaster`, `relay`), `GlobalRawMutex`, `SyncCell`, `fmt` macros. Re-exported as `embedded_services`. | |
Comment on lines
+145
to
+151
| The required helpers (`cargo-hack`, `cargo-deny`, `cargo-machete`, | ||
| `cargo-vet`, `grcov`) are installed in CI via `taiki-e/install-action` and | ||
| `EmbarkStudios/cargo-deny-action`. Locally: | ||
|
|
||
| ```shell | ||
| cargo install cargo-hack cargo-deny cargo-machete cargo-vet | ||
| ``` |
| - CI workflows (see `.github/workflows/`): | ||
| - `check.yml` — fmt, doc, hack-clippy (stable + beta × two targets), | ||
| deny, test (+ coverage), msrv, example workspaces, machete. | ||
| - `rolling.yml` — periodic refresh against newer toolchains. |
Comment on lines
+1
to
+4
| > **Note:** See [`AGENTS.md`](../AGENTS.md) at the repository root for the | ||
| > canonical, agent-agnostic briefing (workspace layout, commands, | ||
| > conventions, and contribution rules). This file mirrors and extends it | ||
| > with Copilot-specific guidance; keep the two in sync when updating either. |
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).