Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR adds a new GitHub Copilot prompt template for automated pull request reviews. The prompt provides comprehensive instructions for an AI agent to perform thorough code reviews across 13 categories including correctness, security, privacy, error handling, code quality, architecture, testing, performance, documentation, standards, accessibility, concurrency, and regulatory compliance.
Changes:
- Adds
audit-pr.prompt.mdprompt file with structured PR review guidelines - Includes YAML frontmatter defining prompt metadata (title, scope, targets, labels)
- Provides 3-step review process: PR alignment check, categorized code review, and overall summary
| @@ -0,0 +1,282 @@ | |||
| --- | |||
There was a problem hiding this comment.
The readme.md file in the .github/prompts directory documents the existing prompts (audit-docs.prompt.md and audit-quality.prompt.md) but does not include documentation for this new audit-pr.prompt.md file. The readme should be updated to include a section describing this new PR review prompt, following the same format as the existing prompt descriptions (with Purpose, Key Features, When to Use, etc.).
| - `#getJiraIssueRemoteIssueLinks` | ||
| - `#getJiraIssueTypeMetaWithFields` | ||
| - `#getJiraProjectIssueTypesMetadata` | ||
| - `#searchJiraIssuesUsingJql` |
There was a problem hiding this comment.
The prompt references several Jira-related tools (#getJiraIssue, #getJiraIssueRemoteIssueLinks, etc.) and GitHub issue tools (#issue_fetch, #issue_read) without verification that these tools are available in the GitHub Copilot environment. If these tools don't exist, the prompt will confuse users or fail to execute correctly. Consider adding a note that these tools are optional/conditional, or verify their availability in the target environment.
| - `#searchJiraIssuesUsingJql` | |
| - `#searchJiraIssuesUsingJql` | |
| - **Note:** These tools may not be available in all GitHub Copilot environments. If you cannot access them, do not attempt to call them; instead, infer requirements from the PR title/description, visible ticket links, and any in-PR context. |
|
|
||
|
|
There was a problem hiding this comment.
There are two empty lines between Category 9 and Category 10, which is inconsistent with the single empty line separator used between all other categories in this document. For consistency, reduce this to a single empty line.
| - Does the change introduce any synchronous blocking operations in an async context? | ||
| - Are there any memory leaks (event listeners not cleaned up, subscriptions not unsubscribed, file handles not closed)? | ||
|
|
||
| - Do the changes in the PR cause existing documentation to become inaccurate or misleading (drift)? If so, flag the specific docs that need updating. |
There was a problem hiding this comment.
This line appears to be a misplaced fragment that belongs to Category 9 (Documentation & Comments). It's currently placed between Category 8 (Performance & Efficiency) and Category 9, creating confusion about which category it belongs to. This line should be moved inside Category 9, and the duplicate on line 185 should be removed.
| - Are complex or non-obvious sections of code explained with a "why" comment, not just "what"? | ||
| - Is the PR description or linked ticket updated to reflect the implementation approach? | ||
| - Are any README or external docs that describe changed functionality updated? | ||
| - Does the changes in the PR cause existing documentation to become inaccurate or misleading (drift)? If so, flag the specific docs that need updating. |
There was a problem hiding this comment.
This line is duplicated from line 176. The documentation drift check appears twice in Category 9, which is redundant. Remove this duplicate line.
| - Does the changes in the PR cause existing documentation to become inaccurate or misleading (drift)? If so, flag the specific docs that need updating. |
| - **Protobuf:** Protobuf Style Guide, proto3 best practices | ||
| - **R:** Google R Style Guide | ||
| - **HTML & CSS/SCSS:** W3C standards | ||
| - **SQL:** Consistent naming, query optimisation, proper indexing |
There was a problem hiding this comment.
The word "optimisation" uses British spelling, which is inconsistent with American spelling used elsewhere in the repository. The codebase uses American English spelling conventions (e.g., "behavior" not "behaviour"). Change "optimisation" to "optimization" for consistency.
| - **SQL:** Consistent naming, query optimisation, proper indexing | |
| - **SQL:** Consistent naming, query optimization, proper indexing |
1 participant
No description provided.