-
Notifications
You must be signed in to change notification settings - Fork 77
Add contribution guidelines for pull requests to copilot review #1053
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d0d94eb
Add contribution guidelines for pull requests to copilot review
mbaluda 38878e5
Update copilot instructions for reporting checks
mbaluda cd5940a
Update change note requirements and reporting language
mbaluda 1b854ef
Update .github/copilot-instructions.md
mbaluda 7c0e8eb
Update .github/copilot-instructions.md
mbaluda 83da8b3
Update .github/copilot-instructions.md
mbaluda c8ef2de
Update .github/copilot-instructions.md
mbaluda File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| A change note is required for any pull request which modifies: | ||
| - The structure or layout of the release artifacts. | ||
| - The evaluation performance (memory, execution time) of an existing query. | ||
| - The results of an existing query in any circumstance. | ||
|
|
||
| If the pull request only adds new rule queries, a change note is not required. | ||
| Confirm that either a change note is not required or the change note is required and has been added. | ||
|
|
||
| For PRs that add new queries or modify existing queries, also consider the following review checklist: | ||
| - Confirm that the output format of shared queries is valid. | ||
| - Have all the relevant rule package description files been checked in? | ||
| - Have you verified that the metadata properties of each new query is set appropriately? | ||
| - Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases? | ||
| - Are all the alerts in the expected file annotated as NON_COMPLIANT in the test source file? | ||
mbaluda marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Are the alert messages properly formatted and consistent with the style guide? | ||
| - Does the query have an appropriate level of in-query comments/documentation? | ||
| - Does the query not reinvent features in the standard library? | ||
mbaluda marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Can the query be simplified further (not golfed!) | ||
mbaluda marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Only report checks that fail | ||
mbaluda marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.