Skip to content

ci: specify agents shouldn't use #N in reviews#119

Merged
pablodeymo merged 1 commit intomainfrom
update-review-prompt
Feb 11, 2026
Merged

ci: specify agents shouldn't use #N in reviews#119
pablodeymo merged 1 commit intomainfrom
update-review-prompt

Conversation

@MegaRedHand
Copy link
Collaborator

See lambdaclass/ethrex#6187 for more context.

Review agents make use of #N for numbering comments, which triggers GitHub references, linking all reviewed PRs with links to the first PRs of the repo (see #1 for an example).

@github-actions
Copy link

🤖 Kimi Code Review

This PR only adds formatting rules to the AI review prompt file. The changes are:

  • Added two bullet points about GitHub formatting rules
  • Added "Collapse comment" at the end

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

@github-actions
Copy link

🤖 Codex Code Review

No code changes in this PR; only .github/prompts/ai-review.md updated. No consensus/security/perf implications.

Minor nit:

  • .github/prompts/ai-review.md: the added line ends with “Collapse comment”, which looks like a stray UI artifact. Consider removing it for clarity.

Automated review by OpenAI Codex · custom prompt

@github-actions
Copy link

🤖 Claude Code Review

Perfect. Now I have full context. Let me provide the review:


PR Review: CI - Specify agents shouldn't use #N in reviews

Summary

This PR adds formatting rules to the AI review prompt to prevent agents from using #N syntax for enumeration, which GitHub incorrectly interprets as issue/PR references.

Review Findings

✅ Correctness

The 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 Quality

The added rules are clear and provide both:

  1. What NOT to do (with examples: #1, #2)
  2. What to DO instead (numbered lists 1., 2. or bullet points)
  3. How to refer back to items ("Item 1", "Point 2")

Minor Issue - Line 24

Typo in the added text:

.github/prompts/ai-review.md:24

The line ends with Collapse comment which appears to be a UI artifact that was accidentally copied:

- When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".Collapse comment

Should be:

- When referring back to items, use "Item 1", "Point 2", etc. — never "Issue #1" or "#1".

Recommendation

Remove the trailing Collapse comment text from line 24. This appears to be a copy-paste artifact from the GitHub UI.


Overall assessment: Good fix for a legitimate issue. Just needs cleanup of the trailing UI artifact.


Automated review by Claude (Anthropic) · custom prompt

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 11, 2026

Greptile Overview

Greptile Summary

Added formatting rules to the AI review prompt to prevent using #N syntax for enumeration, which GitHub incorrectly renders as issue/PR references. This prevents unwanted cross-references between reviewed PRs and repository issues.

  • Added clear instructions to use numbered lists (1., 2.) or bullet points instead of #N syntax
  • Specified alternative phrasing ("Item 1", "Point 2") when referring to previously mentioned items
  • Minor issue: accidental "Collapse comment" text at end of line 24 needs removal

Confidence Score: 4/5

  • This PR is safe to merge after fixing the minor syntax error
  • The change is simple and straightforward - adding documentation to prevent a known issue. Only concern is the accidental "Collapse comment" text that needs removal before merging
  • .github/prompts/ai-review.md needs the "Collapse comment" text removed from line 24

Important Files Changed

Filename Overview
.github/prompts/ai-review.md Added formatting rules to prevent #N syntax in reviews; contains accidental "Collapse comment" text at end

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile


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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "Collapse comment" from the end of this line - appears to be accidentally copied UI text from GitHub.

Suggested change
- 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.

@pablodeymo pablodeymo merged commit b0c575a into main Feb 11, 2026
6 of 7 checks passed
@pablodeymo pablodeymo deleted the update-review-prompt branch February 11, 2026 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants