Merged
Conversation
Coverage Report✅ 88.1% overall coverage
|
There was a problem hiding this comment.
Pull request overview
This PR tightens the repository’s steward/agent guidance by adding explicit “Contract Checklist” sections across the root and scoped AGENTS.md files, aiming to make cross-surface contract repairs (tests/docs/examples/scaffold/etc.) more consistent and evidence-driven.
Changes:
- Added root-level steward guidance for contract checklists, parity matrices, synthesis requirements, and collateral update expectations.
- Added
## Contract Checklistsections to scoped steward files (tests, templates, input, scaffold, core, docs, examples, site, benchmarks). - Added a towncrier changelog fragment documenting the process change.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| AGENTS.md | Adds root contract checklist + steward signal/synthesis requirements and done criteria updates. |
| tests/AGENTS.md | Adds test-domain contract checklist (regressions, parity matrices, free-threading coverage notes). |
| src/milo/templates/AGENTS.md | Adds template-domain contract checklist (template checks, strict-undefined, rendering evidence). |
| src/milo/input/AGENTS.md | Adds input-domain contract checklist (decoder fixtures, raw-mode cleanup, non-TTY behavior). |
| src/milo/_scaffold/AGENTS.md | Adds scaffold-domain contract checklist (generated path testing and collateral alignment). |
| src/milo/AGENTS.md | Adds core-domain contract checklist (CLI/programmatic/MCP parity, schema coverage, benchmarks). |
| site/AGENTS.md | Adds site-docs contract checklist (docs parity, snippet tagging, link/navigation validity). |
| examples/AGENTS.md | Adds examples contract checklist (drift checks, template compilation, smoke tests). |
| docs/AGENTS.md | Adds agent-docs contract checklist (quickstart/testing doc updates, snippet drift expectations). |
| benchmarks/AGENTS.md | Adds benchmarks contract checklist (when to add/update benchmarks and evidence expectations). |
| changelog.d/steward-contract-checklists.changed.md | Towncrier fragment describing the process change. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - User Impact: how humans, agents, or downstream CLIs experience the bug or drift. | ||
| - Required Fix: the smallest behavior or docs change that restores the invariant. | ||
| - Required Proof: tests, docs checks, snippets, benchmarks, or manual checks that must move with the fix. | ||
| - Collateral: docs, examples, scaffold, llms.txt, changelog, migration notes, or benchmarks that also need updates; write "none: <reason>" when not applicable. |
|
|
||
| ## Contract Checklist | ||
| - Template changes run `uv run python scripts/check_templates.py` and update snapshots or focused rendering tests as needed. | ||
| - Form/help/progress/error template changes check the producer data shape in Python code, docs examples, scaffold, and examples. |
Comment on lines
+21
to
+24
| - Public CLI, MCP, schema, scaffold, or verify changes update `docs/agent-quickstart.md` or `docs/testing.md`, or the PR explains why these docs are unaffected. | ||
| - New or changed command snippets use current flags, current import paths, and a runnable project shape. | ||
| - Structured error behavior changes include an agent-parseable example or a `no docs impact` note. | ||
| - Tagged code fences are covered by `uv run python scripts/check_docs_snippets.py`; untagged snippets must be intentionally illustrative. |
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.
Summary
Tightens the steward system so future bugbashes and cross-boundary changes produce contract-oriented findings, explicit synthesis, and reliable collateral updates.
What changed
## Contract Checklistsections to every scopedAGENTS.mdsteward file.Why
The project-wide bugbash showed the steward model is useful when it turns a local bug into a full contract repair across code, tests, docs, and onboarding surfaces. This PR makes that behavior repeatable instead of relying on reviewer instinct.
Validation
git diff --checkpassedAGENTS.mdfiles include## Contract Checklistmake docs-testpassedSteward Notes
Consulted root and all scoped steward files.
Decisions:
no collateral: <reason>style notes when tests/docs/examples do not need to move.Risks:
Follow-up: