Skip to content

Commit cbd8fd6

Browse files
authored
chore: improve PR template (#171)
## 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. - [ ] Integration tests pass locally *If not, why:* Just an MD update. No code changes. - [ ] I have updated integration tests (if needed) *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 b2a5dd0 commit cbd8fd6

File tree

2 files changed

+153
-2
lines changed

2 files changed

+153
-2
lines changed

.crux_template.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
## Description
2+
3+
### Why is this change being made?
4+
5+
1.
6+
7+
8+
### What is changing?
9+
10+
1.
11+
12+
13+
### Related Links
14+
- **Ticket/Issue**:
15+
- **Design Doc**:
16+
17+
---
18+
19+
## Revision History
20+
21+
<!-- Create a new entry in this section when publishing new revisions. Leave blank for Revision 1. -->
22+
23+
### Revision X:
24+
25+
#### What has changed since the last revision?
26+
27+
1.
28+
29+
---
30+
31+
## Testing
32+
33+
### How was this tested?
34+
35+
1.
36+
37+
38+
### When testing locally, provide testing artifact(s):
39+
40+
1.
41+
42+
---
43+
44+
## Reviewee Checklist
45+
46+
**Update the checklist on each revision:**
47+
48+
- [ ] I have reviewed, tested and understand all changes
49+
50+
*If not, why:*
51+
- [ ] I have filled out the Description and Testing sections above
52+
53+
*If not, why:*
54+
- [ ] I have updated the Revision History section (if publishing a new revision)
55+
56+
*If not, why:*
57+
- [ ] Build and Unit tests are passing
58+
59+
*If not, why:*
60+
- [ ] Unit test coverage for changes is adequate (> 80%)
61+
62+
*If not, why:*
63+
- [ ] Integration tests pass locally
64+
65+
*If not, why:*
66+
- [ ] I have updated integration tests (if needed)
67+
68+
*If not, why:*
69+
- [ ] I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise)
70+
71+
*If not, why:*
72+
- [ ] I have added explanatory comments for complex logic, new classes/methods and new tests
73+
74+
*If not, why:*
75+
- [ ] I have updated README/documentation (if needed)
76+
77+
*If not, why:*
78+
- [ ] I have clearly called out breaking changes (if any)
79+
80+
*If not, why:*
81+
82+
---
83+
84+
## Reviewer Checklist
85+
86+
**All reviewers please ensure the following are true before reviewing each revision:**
87+
88+
- Reviewee checklist has been accurately filled out
89+
- Code changes align with stated purpose in description
90+
- Test coverage adequately validates the changes

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,67 @@
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+
- [ ] Integration tests pass locally
43+
*If not, why:*
44+
- [ ] I have updated integration tests (if needed)
45+
*If not, why:*
46+
- [ ] I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise)
47+
*If not, why:*
48+
- [ ] I have added explanatory comments for complex logic, new classes/methods and new tests
49+
*If not, why:*
50+
- [ ] I have updated README/documentation (if needed)
51+
*If not, why:*
52+
- [ ] I have clearly called out breaking changes (if any)
53+
*If not, why:*
54+
55+
---
56+
57+
## Reviewer Checklist
58+
59+
**All reviewers please ensure the following are true before reviewing:**
60+
61+
- Reviewee checklist has been accurately filled out
62+
- Code changes align with stated purpose in description
63+
- Test coverage adequately validates the changes
64+
65+
---
566

667
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)