Skip to content

docs: add AGENTS.md and model-selection guidance#28

Merged
felipebalbi merged 2 commits into
OpenDevicePartnership:mainfrom
felipebalbi:improve-agentic-workflow
May 28, 2026
Merged

docs: add AGENTS.md and model-selection guidance#28
felipebalbi merged 2 commits into
OpenDevicePartnership:mainfrom
felipebalbi:improve-agentic-workflow

Conversation

@felipebalbi
Copy link
Copy Markdown
Contributor

This PR adds an AGENTS.md file (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 ...

  • New AGENTS.md with project overview, build/test/lint/fmt commands, code layout, contribution patterns, and any quirks observed (e.g., defmt feature constraints, nightly-only rustfmt.toml options, workspace layout).
  • .github/copilot-instructions.md updated to point at AGENTS.md as the authoritative source, so Copilot-specific configuration does not drift out of sync with the broader agent guidance. Where no copilot-instructions.md existed, a minimal pointer file was added.

Commit 2 — docs(AGENTS.md): add model selection & cost discipline section

  • Adds a "Model selection & cost discipline" section covering when to use premium vs. cheap models, escalation/de-escalation triggers, sub-agent routing defaults, /fleet rules, 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).

Copilot AI review requested due to automatic review settings May 26, 2026 19:27
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds repository-specific, AI-agent-friendly documentation intended to capture build/test commands, layout, and contribution conventions in one canonical place, and points Copilot instructions at it to avoid drift.

Changes:

  • Added AGENTS.md with project overview, repo layout, CI-mirrored commands, and workflow/convention notes.
  • Updated .github/copilot-instructions.md to direct agents to AGENTS.md.
  • Added “Model selection & cost discipline” guidance to AGENTS.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.

File Description
AGENTS.md New canonical repository guidance for agents (commands, conventions, generation rules, model-selection section).
.github/copilot-instructions.md Adds a minimal pointer to AGENTS.md as the canonical guidance source.

Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
@felipebalbi felipebalbi marked this pull request as ready for review May 26, 2026 19:52
@felipebalbi felipebalbi requested a review from a team as a code owner May 26, 2026 19:52
@felipebalbi felipebalbi enabled auto-merge (squash) May 26, 2026 20:06
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
@kurtjd kurtjd force-pushed the improve-agentic-workflow branch from fa85ce5 to 8352578 Compare May 28, 2026 21:12
@felipebalbi felipebalbi merged commit 3f28d0b into OpenDevicePartnership:main May 28, 2026
11 checks passed
@felipebalbi felipebalbi deleted the improve-agentic-workflow branch May 28, 2026 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants