Skip to content

Commit 80f8fb8

Browse files
Copilotoscarsj
andcommitted
Update PR template to require test coverage or justification
Co-authored-by: oscarsj <[email protected]>
1 parent 1373f1f commit 80f8fb8

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,16 @@ For internal use only. Please select the risk level of this change:
2929

3030
#### How did/will you validate this change?
3131

32-
<!-- Delete options that don't apply. -->
32+
<!-- Delete options that don't apply. Be explicit about test coverage. If no new tests are added, explain why they are not needed. -->
3333

3434
- **Test repository** - This change will be tested on a test repository before merging.
35-
- **Unit tests** - I am depending on unit test coverage (i.e. tests in `.test.ts` files).
35+
- **Unit tests** - I am depending on existing unit test coverage (i.e. tests in `.test.ts` files).
3636
- **End-to-end tests** - I am depending on PR checks (i.e. tests in `pr-checks`).
37+
- **New / updated tests** - I have added or updated unit / end-to-end tests to cover new or changed functionality (summarize below) OR I am providing a justification below for why test updates are not required.
3738
- **Other** - Please provide details.
38-
- **None** - I am not validating these changes.
39+
- **None** - I am not validating these changes (provide justification below).
40+
41+
<!-- If you selected "New / updated tests" or omitted adding tests, briefly summarize test additions or rationale: -->
3942

4043
#### If something goes wrong after this change is released, what are the mitigation and rollback strategies?
4144

@@ -57,5 +60,6 @@ For internal use only. Please select the risk level of this change:
5760
### Merge / deployment checklist
5861

5962
- Confirm this change is backwards compatible with existing workflows.
63+
- Tests (unit and/or end-to-end) have been added or updated as needed and are passing, OR a justification for not adding tests has been provided.
6064
- Consider adding a [changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md) entry for this change.
6165
- Confirm the [readme](https://github.com/github/codeql-action/blob/main/README.md) and docs have been updated if necessary.

0 commit comments

Comments
 (0)