Add query validation guidelines to copilot review instructions#1092
Open
Add query validation guidelines to copilot review instructions#1092
Conversation
Added guidelines for validating query style in code reviews.
Updated QLDoc style guide with detailed requirements for documentation, including general, language, and specific item requirements. Added examples for predicates, classes, and modules.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository’s Copilot code review instructions to add a dedicated section for validating CodeQL query style during reviews (exclusions, alert-message style, and QLDoc expectations).
Changes:
- Adds “Validating Query style” guidance requiring use of
isExcludedon primary locations. - Adds alert message style requirements (sentence structure, quoting, placeholders/links).
- Adds an extensive QLDoc style guide (general rules + per-item/predicate/class/module conventions).
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:142
- This section states “Use American English” (line 95), but this line uses the British spelling “behaviour”. Consider changing it to “behavior” for consistency.
1. If the predicate has more complex behaviour, for example multiple arguments are conceptually "outputs", it can be described like a predicate without a result. For example
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added guidelines for validating query style in code reviews.
Description
This pull request updates the
.github/copilot-instructions.mddocumentation to add comprehensive style guidelines for query validation during code review. The new section outlines mandatory requirements for query style, including the use of theisExcludedpredicate, standards for alert messages, and QLDoc documentation expectations.Change request type
.ql,.qll,.qlsor unit tests)Rules with added or modified queries
Release change checklist
A change note (development_handbook.md#change-notes) is required for any pull request which modifies:
If you are only adding new rule queries, a change note is not required.
Author: Is a change note required?
🚨🚨🚨
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.
Reviewer: Confirm that either a change note is not required or the change note is required and has been added.
Query development review checklist
For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:
Author
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
Reviewer
As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.