Skip to content

Add .agents/AGENTS.md with Rust check and docs-sync policy#65

Merged
mbe24 merged 3 commits into
mainfrom
copilot/add-agents-md-with-rust-checks
Mar 11, 2026
Merged

Add .agents/AGENTS.md with Rust check and docs-sync policy#65
mbe24 merged 3 commits into
mainfrom
copilot/add-agents-md-with-rust-checks

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 11, 2026

No agent-focused policy existed, leading to inconsistent post-change behavior around Rust quality gates and documentation updates.

.agents/AGENTS.md (new)

  • Mandates exactly two Rust post-change commands — no more, no less:
    cargo fmt
    cargo clippy --all-targets --no-deps --features telemetry-otel -- -W clippy::pedantic
  • Explicit docs-sync targets for any behavior/usage change: README.md, docs/, and templates/skills/99problems/SKILL.md (skill file only when usage or workflow changes)
  • Scope boundary: no runtime changes, no new CI, no command-list expansion without a policy revision

.gitignore

  • Replaced .agents/skills/ with .agents/* + !.agents/AGENTS.md — blacklists all agent-generated artifacts, whitelists only the policy file
Original prompt

This section details on the original issue you should resolve

<issue_title>[Feature] Add AGENTS.md with minimal Rust checks and docs sync rules</issue_title>
<issue_description>### Problem

The repository lacks a dedicated AGENTS.md that defines clear execution rules for automation agents. We currently have contributor and CI guidance, but no single agent-focused policy document.

This leads to inconsistent agent behavior, especially around post-change Rust checks and documentation updates.

Design

Add an AGENTS.md with a minimal, explicit rule set.

For Rust code changes, require exactly:

  1. cargo fmt
  2. cargo clippy --all-targets --no-deps --features telemetry-otel -- -W clippy::pedantic

For behavior/usage changes, require documentation sync in the same PR:

  1. README.md
  2. docs/ content (including issue [Feature] Set up public documentation site with Read the Docs, MkDocs, and versioned docs #49 related updates)
  3. template/skills/99problems/SKILL.md when usage/workflow changes

Scope

  • Create AGENTS.md in ./agents
  • Whitelist .agents/AGENTS.md in .gitignore, blacklist everything else in .agents/
  • Define mandatory Rust post-change commands (minimal list above).
  • Define docs-sync requirements for behavior changes.
  • Keep wording consistent with current contributor/CI guidance.

Boundary

  • No runtime code changes.
  • No new CI jobs or workflow changes.
  • No expansion beyond the two mandatory Rust commands in this iteration.

Acceptance Criteria

  • AGENTS.md exists in .agents/
  • Rust-change checklist contains only the two agreed commands.
  • Docs-sync requirements are explicit (README.md, docs/, skill file when relevant).
  • Guidance does not contradict existing project process docs/workflows.

Context

This is a lightweight process hardening change to make agent contributions more predictable and easier to review.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: mbe24 <7420624+mbe24@users.noreply.github.com>
Copilot AI changed the title [WIP] Add AGENTS.md with minimal Rust checks and documentation rules Add .agents/AGENTS.md with Rust check and docs-sync policy Mar 11, 2026
@mbe24 mbe24 marked this pull request as ready for review March 11, 2026 16:11
@mbe24 mbe24 merged commit 8a40a46 into main Mar 11, 2026
6 checks passed
@mbe24 mbe24 deleted the copilot/add-agents-md-with-rust-checks branch March 11, 2026 16:30
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.

[Feature] Add AGENTS.md with minimal Rust checks and docs sync rules

2 participants