Skip to content

Commit 6b428ef

Browse files
authored
chore: update PR template (#190)
## Description ### Why is this change being made? 1. Standardize the PR process by adding reviewee and reviewer checklists that ensure consistent validation steps, improve code quality, and make reviews more efficient. ### What is changing? 1. Setting up change review template for the repo. ### Related Links - **Issue #, if available**: N/A --- ## Testing ### How was this tested? 1. Validated the MD preview. The template needs to be merged to the main branch to be auto applied. ### When testing locally, provide testing artifact(s): 1. N/A --- ## Reviewee Checklist **Update the checklist after submitting the PR** - [x] I have reviewed, tested and understand all changes *If not, why:* - [x] I have filled out the Description and Testing sections above *If not, why:* - [x] Build and Unit tests are passing *If not, why:* Just an MD update. No code changes. - [x] Unit test coverage check is passing *If not, why:* Just an MD update. No code changes. - [x] I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise) *If not, why:* - [ ] I have added explanatory comments for complex logic, new classes/methods and new tests *If not, why:* Just an MD update. No code changes. - [ ] I have updated README/documentation (if needed) *If not, why:* No relevant doc changes required. - [ ] I have clearly called out breaking changes (if any) *If not, why:* Just an MD update. No code changes. --- ## Reviewer Checklist **All reviewers please ensure the following are true before reviewing:** - Reviewee checklist has been accurately filled out - Code changes align with stated purpose in description - Test coverage adequately validates the changes --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent a256a25 commit 6b428ef

File tree

1 file changed

+59
-2
lines changed

1 file changed

+59
-2
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 59 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,63 @@
1-
*Issue #, if available:*
1+
## Description
22

3-
*Description of changes:*
3+
### Why is this change being made?
44

5+
1.
6+
7+
8+
### What is changing?
9+
10+
1.
11+
12+
13+
### Related Links
14+
- **Issue #, if available**:
15+
16+
---
17+
18+
## Testing
19+
20+
### How was this tested?
21+
22+
1.
23+
24+
### When testing locally, provide testing artifact(s):
25+
26+
1.
27+
28+
---
29+
30+
## Reviewee Checklist
31+
32+
**Update the checklist after submitting the PR**
33+
34+
- [ ] I have reviewed, tested and understand all changes
35+
*If not, why:*
36+
- [ ] I have filled out the Description and Testing sections above
37+
*If not, why:*
38+
- [ ] Build and Unit tests are passing
39+
*If not, why:*
40+
- [ ] Unit test coverage check is passing
41+
*If not, why:*
42+
- [ ] I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise)
43+
*If not, why:*
44+
- [ ] I have added explanatory comments for complex logic, new classes/methods and new tests
45+
*If not, why:*
46+
- [ ] I have updated README/documentation (if needed)
47+
*If not, why:*
48+
- [ ] I have clearly called out breaking changes (if any)
49+
*If not, why:*
50+
51+
---
52+
53+
## Reviewer Checklist
54+
55+
**All reviewers please ensure the following are true before reviewing:**
56+
57+
- Reviewee checklist has been accurately filled out
58+
- Code changes align with stated purpose in description
59+
- Test coverage adequately validates the changes
60+
61+
---
562

663
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

0 commit comments

Comments
 (0)