Enforce inline review comments; keep top-level summary brief and non-actionable #1
Conversation
… keep summary brief and non-actionable; adjust formatting and README to reflect inline review flow
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
The shift to inline, line-anchored comments with a brief, non-actionable summary looks solid and should reduce top-level noise. I left a couple of small wording tweaks to make the guidance fully explicit and consistent across templates and README.
🤖 Automated review complete. Please react with 👍 or 👎 on the individual review comments to provide feedback on their usefulness.
| - Use code blocks for multi-line code examples | ||
| - Include file paths and line numbers when referencing specific code locations | ||
| - In inline review comments, prefer GitHub suggestion blocks (```suggestion) for concrete code changes; ensure patches are minimal and accurate | ||
| - Do not include code blocks or specific code suggestions in the top-level review summary |
There was a problem hiding this comment.
Minor wording/clarity: consider showing the full fence so readers see the expected form of a suggestion block (open and close). For example: ("```suggestion ... ```")
| 4. **AI Processing**: Calls the Augment Agent to analyze the changes and generate a review | ||
| 5. **PR Update**: The Augment Agent updates the PR description with the generated review content | ||
| 5. **PR Review Submission**: The Augment Agent submits a single GitHub review containing a brief summary and multiple inline comments anchored to specific lines in the PR diff (including suggestion blocks where appropriate) | ||
|
|
There was a problem hiding this comment.
Nit: to be explicit/consistent with the templates, call these GitHub suggestion blocks.
| 5. **PR Review Submission**: The Augment Agent submits a single GitHub review containing a brief summary and multiple inline comments anchored to specific lines in the PR diff (including GitHub suggestion blocks where appropriate) |
| - Do not post comments outside of the single review | ||
| - 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 ... ```) | ||
| - 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. |
There was a problem hiding this comment.
Tiny consistency tweak to match the phrasing used elsewhere ("top-level review summary").
| - Submit a single GitHub review containing your inline comments plus the brief summary. Do not create multiple reviews. | |
| - The top-level 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. |
Update review behavior: enforce inline comments and concise summary
This change updates our review prompts and documentation to prioritize line-anchored inline comments for code-specific feedback and to keep the top-level review summary brief and non-actionable.
Why
Reduce sprawling top-level comments and drive concrete, actionable suggestions directly onto the relevant lines, improving clarity, adoption, and signal-to-noise in reviews.
What’s changed
Impact
🤖 This description was generated automatically. Please react with 👍 if it's helpful or 👎 if it needs improvement.