Files
ophyd_devices/.github/pull_request_review_template.md
2026-10-03 15:19:13 +02:00

5.1 KiB

Verdict: {{APPROVE / REQUEST CHANGES}} — {{brief summary of findings or absence of findings}}.

Reviewer: {{reviewer or agent name}} Model: {{full model name, variant, and reasoning effort, e.g. GPT-6 Astra Ultra}} Reviewed commit: [{{full head SHA}}]({{repository URL}}/commit/{{full head SHA}})

Review details

Base: [{{full base SHA}}]({{repository URL}}/commit/{{full base SHA}}) Scope: {{head branch}} against {{base branch}}; {{files and behaviors reviewed}}.

Findings introduced or exposed by this change

1. [{{introduced / exposed}}] {{one-line defect}}

Severity: {{severity and whether a fix is required}} · Confidence: {{CONFIRMED / PLAUSIBLE}} Location: [{{file}}:{{line}}]({{immutable source permalink}})

{{Concrete trigger, incorrect behavior, impact, and how this change causes or exposes it.}}

Evidence: {{test result, reproduction, or concrete code path}}. Suggested fix: {{specific change; name an existing helper or hook where appropriate}}.

What was checked and found sound

  • {{Author claim or risky behavior checked, and the evidence supporting it.}}
  • {{Material assumption or explicitly accepted behavior, if relevant.}}

Validation

  • {{exact command}} → {{result, including passed/failed/skipped counts where relevant}}.
  • {{Relevant environment, simulated services, or manual reproduction and result.}}
  • {{For device changes: hardware model/firmware tested, or explicitly simulation/mock only; lifecycle/status completion and stop behavior checked; omit if not applicable.}}
  • {{For config changes: ophyd_test command and result; use --connect only when hardware validation is explicitly requested; omit if not applicable.}}
  • Limitations: {{checks not run, unverified claims, or gaps and their effect on the assessment; omit if none}}.

Optional improvements

  • {{Non-blocking suggestion within the change; cite the rule for convention feedback.}}

Pre-existing issues — separate, non-blocking follow-ups

  • [{{file}}:{{line}}]({{immutable source permalink}}) — {{issue, impact, and evidence it is pre-existing}}.