Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit d0d94eb

Browse files
authored
Add contribution guidelines for pull requests to copilot review
Added guidelines for reviewing PRs with copilot.
1 parent b0e343f commit d0d94eb

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
A change note is required for any pull request which modifies:
2+
3+
- The structure or layout of the release artifacts.
4+
- The evaluation performance (memory, execution time) of an existing query.
5+
- The results of an existing query in any circumstance.
6+
If only adding new rule queries, a change note is not required.
7+
8+
Confirm that either a change note is not required or the change note is required and has been added.
9+
10+
For PRs that add new queries or modify existing queries, also consider the following review checklist:
11+
12+
- Confirm that the output format of shared queries is valid.
13+
- Have all the relevant rule package description files been checked in?
14+
- Have you verified that the metadata properties of each new query is set appropriately?
15+
- Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
16+
- Are all the alerts in the expected file annotated as NON_COMPLIANT in the test source file?
17+
- Are the alert messages properly formatted and consistent with the style guide?
18+
- Does the query have an appropriate level of in-query comments/documentation?
19+
- Does the query not reinvent features in the standard library?
20+
- Can the query be simplified further (not golfed!)

0 commit comments

Comments
 (0)