Agents

Copyable instructions for Rust, documentation, source control, task setup, and review.

These snippets are copyable AGENTS.md sections. They provide compact instructions and point back to the canonical guides for detail.

Use snippets as a starting point, then adapt paths and commands to the target repository. Do not copy every snippet by default; choose the sections that match the repo's work.

For agentic workflows, prefer the smallest useful surface. A good default is core.md plus apply-practice-guidance.md, then one task-specific snippet or generated rule domain. Use full doctrine prompt packs only when a broad review, rewrite, or operating-manual pass is worth the extra tokens and round trips.

Core agent instructionsBroad baseline instructions for coding agents working in repositories that adopt these development preferences. The snippet keeps AGENTS.md short while routing agents to canonical guides, principles, mechanisms, and the reviewed rule pack.Reviewed rule agent packGenerated compact execution surface for every reviewed rule. The pack gives agents stable rule IDs and instructions while leaving rationale, examples, and deeper context in the canonical rule files.

Apply practice guidanceCompact instructions for Codex sessions that need to use the shared practice catalog from another repository. The snippet turns broad standards into a task-local application loop without loading the whole catalog or treating preferences as automatic churn.Full documentation doctrine prompt packLarge single-file prompt pack for long-term documentation maintenance. It combines the repos docs rules with writing, review, anti-drift, and anti-AI-slop lessons drawn from this repo, TidySrc, jk, and Komodo-style documentation cleanup work.Full software doctrine prompt packLarge single-file prompt pack that combines the repos software rules and the reasons behind them into one coherent artifact. This version is tuned for Rust-heavy maintenance and refactoring work, especially when existing code needs to be reshaped toward better locality, coherence, ownership, and documentation.Jujutsu agent instructionsCompact source-control instructions for coding agents working in repositories that use jujutsu. The snippet covers fresh changes, descriptions, non-interactive commands, recovery, remote handoff, and publication approval.Markdown and docs agent instructionsCompact documentation instructions for agents editing Markdown, Rustdoc, READMEs, review notes, or adjacent narrative. The snippet focuses on current behavior, local voice, page purpose, drift repair, and markdownlint-compatible formatting.Rust agent instructionsCompact Rust maintainability instructions for agents working on APIs, Rustdoc, tests, dependencies, and reviewable implementation changes. The snippet routes agents toward reader locality, explicit boundaries, documented contracts, validation evidence, and pragmatic performance work.

Coding agent workflow instructionsCompact workflow instructions for repositories that delegate implementation or review work to coding agents. The snippet emphasizes objectives, boundaries, durable handoff, repo-owned context, and feedback that becomes reusable guidance.

Adaptation checklist

Use templates/downstream/ when the downstream repo should carry every reviewed rule.
Keep only snippets that apply to the repo when copying small profile snippets directly.
Use apply-practice-guidance.md when a repo wants agents to choose a small context path before escalating to deeper guidance.
Use full-software-doctrine.md or full-documentation-doctrine.md when one coherent pasteable prompt is more important than token efficiency, latency, or modular loading.
Rewrite guide paths when the target repo stores guidance elsewhere.
Replace validation commands with the repo's actual commands.
Keep source-control instructions aligned with the repo's real workflow.
Prefer short AGENTS.md files that point to deeper guides.

For broad adoption, prefer the downstream template over copying rules.md by hand:

python3 scripts/generate_downstream_template.py --output /path/to/target-repo

The template keeps AGENTS.md short and splits the full reviewed rule pack into generated domain files under docs/development/rules/, so agents can load the relevant rule domains without losing coverage. Treat this repo as the canonical source for the copied rule text; refresh downstream repos from here when the shared rules change.