Skip to content

docs: Document OpenAI review validation matrix #12

Description

@idy

Background

PR #11 introduced three fixed OpenAI review Checks and content-addressed PR, per-Issue, and code evidence. The implementation documentation explains rollout steps, but it does not give maintainers a compact event-to-stage validation matrix for verifying the default-branch caller after installation.

This follow-up is also the first end-to-end consumer test after the new caller and reusable reviewer reach main.

Goal

Document a live validation matrix for the Issue-led OpenAI review workflow in README.md.

The matrix must identify the expected trigger, affected evidence stage, cache mode, and fixed Check for:

  • opening a ready PR;
  • editing only the PR body;
  • editing one linked Issue;
  • pushing a descendant commit;
  • rerunning an unchanged head.

This Issue owns documentation and live workflow validation only. It does not change reviewer behavior, configure a ruleset, merge the test PR, or roll the workflow out to another repository.

Code Changes Tree

README.md    # add the default-branch trigger and stage-cache validation matrix

Design

Add a concise Markdown table near the existing rollout guidance.

Each row must state:

  • the GitHub event or manual action;
  • which of PR, Issue, and Code evidence changes;
  • the expected full, incremental, or reused stage behavior;
  • which of OpenAI PR Review, OpenAI Issue Review, and OpenAI Code Review is expected to be recalculated.

The surrounding text must clarify that:

  • all three fixed Checks are attached to the exact current PR head;
  • Issue edits revalidate plan conformance without resending an unchanged complete code diff;
  • unchanged reruns consume zero model tokens;
  • a workflow-source or policy change intentionally invalidates compatible session evidence and starts the affected stages safely.

The PR body must natively close this Issue and list the validation run links. Live testing may update only this Issue's acceptance checkboxes and the PR description; it must not change reviewer code.

Test And Acceptance Criteria

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions