fix(ai-review): make ai-review prompts more concise (#184) - #188
Merged
Conversation
The ai-review flow produced extremely verbose reviews. Two changes to the review prompt templates make them concise while keeping the important detail: PR review (integrationroute-github-pr-labeled-review): - Add a "keep the review concise" directive: comment only on things that materially affect correctness, security, tests, or maintainability; raise each issue once; skip nitpicks, praise, and restating the diff; hold any overall summary to a few sentences. - Require exactly ONE fix mechanism per change comment instead of both a suggestion block AND a collapsible AI-agent prompt. Prefer the one-click suggestion block for localized edits; fall back to the collapsible prompt only when the fix is architectural/multi-file. This was the largest source of per-comment bulk. Issue review (integrationroute-github-issue-labeled-review): - Add a matching brevity directive: lead with the verdict and the few points that change the decision; skip nitpicks, praise, and restating the issue. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011JZVZWHQDM26vgxFwFTC8g
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
1 participant
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.
What & why
Fixes #184 — the
ai-reviewflow produced reviews that were too verbose.The review is driven entirely by the
promptTemplatein the twoai-reviewIntegrationRoutes, so the fix is to tighten those prompts to emphasize signal over volume while keeping the important detail.Changes
PR review (
integrationroute-github-pr-labeled-review.yaml)suggestionblock and a collapsible AI-agent prompt. Prefer the one-click suggestion block for localized edits; fall back to the collapsible prompt only when the fix is architectural or spans several files. Carrying both on every comment was the biggest source of per-comment bulk.Issue review (
integrationroute-github-issue-labeled-review.yaml)Scope / risk
Prompt-text-only changes inside the Helm templates. Helm escaping (
{{`` ``{{var}}`` ``}}) and thesuggestion/ collapsible-<details>mechanics are preserved — the mechanics still work, an AI review just uses them more sparingly. No code, config, schema, or test changes; no test references the literal prompt text (the routing tests use their own inlinepromptTemplates).Maintainer: apply the ai-review label to this PR to request an automated code review, or the ai-triage label to have the review feedback addressed and the branch brought back in sync with its base. (The automation can't label its own PR, so this needs a human.)