Skip to content

Conversation

@nathro
Copy link
Collaborator

@nathro nathro commented Sep 6, 2025

Remove GitHub suggestion blocks from review prompts and replace with fenced code blocks

This PR updates the review prompt templates to stop using GitHub suggestion blocks and instead rely on regular fenced code blocks for proposed changes. This avoids incorrect/mishandled suggestions and makes before/after examples clearer and more consistent.

Key changes:

  • Update templates/formatting/base.njk: Instruct reviewers not to use GitHub suggestion blocks; when proposing changes, use fenced code blocks with the appropriate language tag, optionally showing "Current code:" and "Suggested improvement:" sections.
  • Update templates/guidelines/base.njk: Clarify comment guidelines to provide concrete improvements using fenced code blocks rather than suggestion blocks.
  • Update templates/request/base.njk: Adjust action requirements to anchor inline comments precisely but avoid suggestion blocks; emphasize using fenced code blocks and clear before/after sections.

Impact:

  • Improves clarity and reduces agent mishandling of suggestions during reviews.
  • No runtime or API changes; affects reviewer/agent guidance only.
  • No migrations or config changes required.

🤖 This description was generated automatically. Please react with 👍 if it's helpful or 👎 if it needs improvement.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Switching from GitHub suggestion blocks to plain fenced code blocks is a good simplification and the guidance reads clearly. I left one small consistency suggestion about straight vs. curly quotes in a template line.


🤖 Automated review complete. Please react with 👍 or 👎 on the individual review comments to provide feedback on their usefulness.

- **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

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

@nathro nathro merged commit b78d854 into main Sep 7, 2025
3 checks passed
@nathro nathro deleted the nathro_remove_suggestion_blocks branch September 7, 2025 19:26
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.

3 participants