Skip to content

docs: add the review-ready bar to AGENTS.md 📝 - #28

Closed
dohernandez wants to merge 1 commit into
v0.6-devfrom
chore/review-ready-bar
Closed

dohernandez wants to merge 1 commit into
v0.6-devfrom
chore/review-ready-bar

Conversation

@dohernandez

Copy link
Copy Markdown
Member

Requirement

Commit the agreed Review-Ready bar into the repo's agent instructions so it travels cross-machine. Agent memory and the handoff channel are machine-local; the only thing that reaches a session on a different machine (or a fresh clone, or an opencode session) is what is committed. AGENTS.md is auto-loaded by every session that clones the repo, so it is the distribution channel. Duplication across repos is intended.

What this PR does — traced to the requirement

  • Adds a ## Review-Ready section to AGENTS.md (the canonical agent-instructions file; CLAUDE.md is a symlink to it), in the hand-maintained preamble above the genvm-tool docs-generated index.
  • Kept faithful to the agreed text: items 1, 2, 3, 6, 7, 9, 10, 11 and the approval / forbidden / not-gated boundary.
  • Adapted to this repo (as instructed, only these): item 4 (local checks + commands: pre-commit hooks, genvm-tool test run, debug build; Linux-only runner artifacts), item 5 (targeted feature coverage via integration/system cases + agentic-fuzzing), item 8 (docs surface: genvm-tool man page / --help, spec vs impl-spec, docs/contributing/). The load-bearing principle is preserved verbatim in spirit: everything testable locally is tested locally before pushing, because CI costs real money.
  • Deliberately excluded: the two rules cut from the earlier draft ("the test proves itself / fails without the fix"; "evidence, not proxies") — not agreed, so not carried here.

Checks run locally (the bar applied to itself)

  • markdown-local-links on AGENTS.md: exit 0 — both new links (testing/README.md, building/build.md) resolve.
  • No trailing whitespace; final newline present.
  • Commit subject and this PR title validated by support/scripts/check-commit-message.py (exit 0).
  • Diff read in full: only AGENTS.md changed (1 file changed, 68 insertions); no submodule or CLAUDE.md-symlink churn.
  • Not applicable, stated explicitly: check-source-text is .rs-only and prettier does not cover markdown; no code changed, so no Rust/Python/build tiers apply; the genvm-tool docs index-vs-disk sync is unaffected (no docs/contributing/ files touched).

Boundary

Opening this PR is not gated. Merge stays Darien's. No CI e2e requested.

@github-actions

Copy link
Copy Markdown

GenVM PR actions

Tick a box to run it (the box unticks itself when handled). Actions only run while the PR has the ci-safe label.

  • Force run full tests
  • Rerun full tests
  • Provision executor PRs
  • Merge into dev
Merge

Requires, on the exact head commit:

  • an approving review from a maintainer (any push revokes it), or the rtm label
  • linear history — 0 commits behind base
  • green full GenVM CI and green cross-repo E2E

Full CI starts only through "Force" or "Rerun full tests" above. "Force" also sets run-full-tests, making future pushes run the full suite; rtm only authorizes Merge.

Every repo lands ONE squashed commit, subject <PR title> (#N).

Commands
  • /genvm-force-merge — repo admin only: land without the review, full-CI and E2E gates, for when those signals are unobtainable, not when they are red. Base, title and 0-behind still apply, and the skip is recorded on the PR.

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 8aa769b0-2b9b-4bd9-b309-82a0240fada9


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@github-actions github-actions Bot added the not rebased branch is behind its base; rebase before it can be merged label Aug 21, 2026
@kp2pml30

Copy link
Copy Markdown
Member

will check it by monday!

@kp2pml30

Copy link
Copy Markdown
Member

closing in favor of #30 . Intent should have been ported

@kp2pml30 kp2pml30 closed this Aug 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-safe not rebased branch is behind its base; rebase before it can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants