ci: specify agents shouldn't use #N in reviews#119
Conversation
🤖 Kimi Code ReviewThis PR only adds formatting rules to the AI review prompt file. The changes are:
The changes are purely documentation-related and don't affect any consensus-critical code. The formatting rules themselves are sensible and will help prevent GitHub from incorrectly linking to issues/PRs. No issues found - this is a straightforward documentation update. Automated review by Kimi (Moonshot AI) · custom prompt |
🤖 Codex Code ReviewNo code changes in this PR; only Minor nit:
Automated review by OpenAI Codex · custom prompt |
🤖 Claude Code ReviewPerfect. Now I have full context. Let me provide the review: PR Review: CI - Specify agents shouldn't use #N in reviewsSummaryThis PR adds formatting rules to the AI review prompt to prevent agents from using Review Findings✅ CorrectnessThe changes are correct and address a real GitHub rendering issue. The PR description references a similar fix in the ethrex project, indicating this is a known pattern across LambdaClass projects. ✅ Documentation QualityThe added rules are clear and provide both:
Minor Issue - Line 24Typo in the added text: The line ends with - When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".Collapse commentShould be: - When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".RecommendationRemove the trailing Overall assessment: Good fix for a legitimate issue. Just needs cleanup of the trailing UI artifact. Automated review by Claude (Anthropic) · custom prompt |
Greptile OverviewGreptile SummaryAdded formatting rules to the AI review prompt to prevent using
Confidence Score: 4/5
|
| Filename | Overview |
|---|---|
| .github/prompts/ai-review.md | Added formatting rules to prevent #N syntax in reviews; contains accidental "Collapse comment" text at end |
|
|
||
| Formatting rules: | ||
| - NEVER use `#N` (e.g. #1, #2) for enumeration — GitHub renders those as issue/PR references. Use `1.`, `2.`, etc. or bullet points instead. | ||
| - When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".Collapse comment |
There was a problem hiding this comment.
Remove "Collapse comment" from the end of this line - appears to be accidentally copied UI text from GitHub.
| - When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".Collapse comment | |
| - When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1". |
Prompt To Fix With AI
This is a comment left during a code review.
Path: .github/prompts/ai-review.md
Line: 24:24
Comment:
Remove "Collapse comment" from the end of this line - appears to be accidentally copied UI text from GitHub.
```suggestion
- When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".
```
How can I resolve this? If you propose a fix, please make it concise.
See lambdaclass/ethrex#6187 for more context.
Review agents make use of
#Nfor numbering comments, which triggers GitHub references, linking all reviewed PRs with links to the first PRs of the repo (see #1 for an example).