Skip to content

Remove suggestion blocks from prompt #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathro merged 1 commit into from
Sep 7, 2025
Merged

Remove suggestion blocks from prompt #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion templates/formatting/base.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

### Code References:
- Use backticks for inline code references (function names, variables, etc.)
- In inline review comments, prefer GitHub suggestion blocks (```suggestion) for concrete code changes; ensure patches are minimal and accurate
- In inline review comments, do NOT use GitHub suggestion blocks. When proposing changes, include regular fenced code blocks with the right language tag. Provide both "Current code:" and "Suggested improvement:" sections where helpful to show before/after clearly
- Do not include code blocks or specific code suggestions in the top-level review summary
- Include file paths and line numbers only within inline comments (not in the summary)
- Use proper syntax highlighting when showing code examples
Expand Down
2 changes: 1 addition & 1 deletion templates/guidelines/base.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
### Comment Guidelines:
- **HIGH CONFIDENCE ONLY**: Only suggest changes you are highly confident will improve the code
- Post one inline comment per distinct issue and location, anchored to the exact file and line in the PR diff
- Provide clear explanations of issues and suggest concrete improvements; when proposing code, use GitHub suggestion blocks in inline comments
- Provide clear explanations of issues and suggest concrete improvements. When proposing code, do NOT use GitHub suggestion blocks. Instead, include regular fenced code blocks with appropriate language tags and, where useful, show “Current code:” and “Suggested improvement:” sections
Copy link
Contributor

@github-actions github-actions bot Sep 6, 2025

Choose a reason for hiding this comment

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

Suggestion: Use straight quotes instead of curly quotes around the section labels to be consistent with the other templates in this PR and avoid potential copy/paste or rendering inconsistencies.

Current code:

... include regular fenced code blocks with appropriate language tags and, where useful, show “Current code:” and “Suggested improvement:” sections

Suggested improvement:

... include regular fenced code blocks with appropriate language tags and, where useful, show "Current code:" and "Suggested improvement:" sections

- Use a constructive, helpful tone - focus on the code, not the person
- Include examples of better approaches when suggesting changes
- Prioritize critical issues over minor style preferences
Expand Down
4 changes: 2 additions & 2 deletions templates/request/base.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You are conducting a comprehensive code review for PR #{{ pr.number }}. You have

## Action Required:
- Use GitHub's review system to post your feedback directly on the relevant lines of code in the PR
- For any code-specific issue, you MUST post an inline review comment anchored to the exact file and line in the PR diff; when proposing code changes, use GitHub suggestion blocks (```suggestion ... ```)
- For any code-specific issue, post an inline review comment anchored to the exact file and line in the PR diff. When proposing code changes, do NOT use GitHub suggestion blocks. Instead, include regular fenced code blocks with appropriate language tags and use clear sections like "Current code:" and "Suggested improvement:"
- The review summary MUST be at most 3 sentences and MUST NOT include code-specific suggestions, code blocks, or file/line references. Do not repeat details from inline comments.
- Submit a single GitHub review containing your inline comments plus the brief summary. Do not create multiple reviews.
- If you cannot find a valid diff anchor for a code-specific suggestion, comment on the closest changed line and clearly reference the exact location; only if no anchor is possible, write one short general comment for that item.
Expand All @@ -40,7 +40,7 @@ You are conducting a comprehensive code review for PR #{{ pr.number }}. You have
- Anchor using line + side; do not use "position".
- Default: side="RIGHT" for added/modified lines; use "LEFT" only for deleted lines.
- Validate anchors: only post an inline comment when you can ensure the anchor targets the intended code; otherwise post one brief general comment.
- Suggestion blocks (```suggestion ... ``` ) only on side="RIGHT"; be especially careful to anchor precisely when providing suggestions.
- Do not use GitHub suggestion blocks. Provide code examples with regular fenced code blocks. Be especially careful to anchor precisely to the intended line(s).
- For multi-line ranges, set start_line/start_side and line/side consistently (same side).

**IMPORTANT**: If you post any review comments, end your review summary with this exact feedback request:
Expand Down