Skip to content

Commit eb65cc0

Browse files
committed
change section descriptions to be comments to the PR author
1 parent 99ea739 commit eb65cc0

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
<!-- Thanks for contributing! -->
22
## Summary
3-
_What conceptually is this PR introducing? If context is already provided from the JIRA ticket, still place it in the
4-
Pull Request as you should not make the reviewer do digging for a basic summary._
3+
<!-- What conceptually is this PR introducing? If context is already provided from the JIRA ticket, still place it in the
4+
Pull Request as you should not make the reviewer do digging for a basic summary. -->
55

66
## Changes in this PR
7-
_What changes did you make to the code? What new APIs (public or private) were added, removed, or edited to generate
8-
the desired outcome explained in the above summary?_
7+
<!-- What changes did you make to the code? What new APIs (public or private) were added, removed, or edited to generate
8+
the desired outcome explained in the above summary? -->
99

1010
## Test Plan
11-
_How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why.
12-
All code should be tested in some way – so please list what your validation strategy was._
11+
<!-- How did you test the code? If you added unit tests, you can say that. If you didn’t introduce unit tests, explain why.
12+
All code should be tested in some way – so please list what your validation strategy was. -->
1313

1414
### Screenshots (optional)
15-
_Usually a great supplement to a test plan, especially if this requires local testing._
15+
<!-- Usually a great supplement to a test plan, especially if this requires local testing. -->
1616

1717
## Checklist
18+
<!-- Do not delete the items provided on this checklist. -->
1819
### Checklist for Author
1920
- [ ] Did you update the changelog (if necessary)?
2021
- [ ] Is the intention of the code captured in relevant tests?
@@ -27,6 +28,6 @@ _Usually a great supplement to a test plan, especially if this requires local te
2728
- [ ] Is all relevant documentation (README or docstring) updated?
2829

2930
## Focus Areas for Reviewer
30-
_List any complex portion of code you believe needs additional scrutiny and explain why._
31+
<!-- List any complex portion of code you believe needs additional scrutiny and explain why. -->
3132

3233
<!-- See also: https://docs.google.com/document/d/1Z-z6BDIBJ9G4fn4MBb7Ql5A1NiSY6nsLfEE3KuU_Btw/edit?tab=t.exaie3tsb7gl#heading=h.asd8fqlsyzb6 -->

0 commit comments

Comments
 (0)