Skip to content

Commit 31379f1

Browse files
committed
fix(examples): steer PR review comments away from GFM table glitches
The model sometimes emitted findings_markdown starting with pipe characters, which GitHub parses as a markdown table and merges with the heading/summary. Tighten reviewer instructions: require ### Findings, forbid pipe tables and backslash-escaped underscores. Add a ### Summary wrapper in the posted comment body so structure stays clear even if the model drifts. Made-with: Cursor
1 parent d5c3522 commit 31379f1

2 files changed

Lines changed: 4 additions & 2 deletions

File tree

examples/pr-review-github-actions/agents/reviewer.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ spec:
2525
"evidence": "<what in the PR suggests this>"
2626
}
2727
],
28-
"findings_markdown": "<Markdown body for humans: use '### Findings' then a bullet per finding; each bullet starts with **severity** · `file` — **title**, then a short line for evidence. Use '-' bullets only. If findings is empty, use a single line like 'No issues found.'>"
28+
"findings_markdown": "<GitHub-flavored Markdown for the PR comment body: start with the line ### Findings, then one '-' bullet per finding. Each bullet: **severity** · `path` — **title**, then a short evidence sentence on the next line (indented is fine). Use '-' bullets only; do not use markdown pipe tables (never begin a line with '|'). Do not backslash-escape underscores in identifiers; use plain text or backticks (e.g. OPENAI_API_KEY or `OPENAI_API_KEY`). If findings is empty, use '### Findings' followed by a line '- No issues found.'>"
2929
}
3030
The "findings" array is the structured source of truth; "findings_markdown" must describe the same items in readable form for GitHub comments.
31-
If there are no issues, return an empty "findings" array, a positive summary, and findings_markdown like "No issues found."
31+
If there are no issues, return an empty "findings" array, a positive summary, and findings_markdown exactly: "### Findings\n- No issues found."
3232
output:
3333
schema: ./schemas/review-output.json

examples/pr-review-github-actions/workflows/pr-review-github.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ spec:
4040
body: |
4141
## Automated review
4242
43+
### Summary
44+
4345
${steps.review_diff.output.summary}
4446
4547
${steps.review_diff.output.findings_markdown}

0 commit comments

Comments
 (0)