-
Notifications
You must be signed in to change notification settings - Fork 10
Enforce inline review comments; keep top-level summary brief and non-actionable #1
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,8 +14,9 @@ | |
|
|
||
| ### Code References: | ||
| - Use backticks for inline code references (function names, variables, etc.) | ||
| - 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Minor wording/clarity: consider showing the full fence so readers see the expected form of a suggestion block (open and close). For example: |
||
| - Include file paths and line numbers only within inline comments (not in the summary) | ||
| - Use proper syntax highlighting when showing code examples | ||
|
|
||
| ### Links and References: | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -28,9 +28,10 @@ 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 | ||||||
| - Suggested changes should be used to make it easier to adopt your suggestions | ||||||
| - **IMPORTANT:** All of your comments should be sent as a single review, not as separate reviews | ||||||
| - 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. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tiny consistency tweak to match the phrasing used elsewhere ("top-level review summary").
Suggested change
|
||||||
| - 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. | ||||||
| - Never use "REQUEST_CHANGES" or "APPROVE" | ||||||
| - If no line-specific suggestions, post a general comment like "Review completed. No suggestions at this time." | ||||||
| - Only a single review should be created, never multiple reviews | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: to be explicit/consistent with the templates, call these GitHub suggestion blocks.