Skip to content

Commit c957e51

Browse files
authored
docs: dev PR template comments
Updated the developer pull request template to include comments for clarity.
1 parent f1abd09 commit c957e51

1 file changed

Lines changed: 14 additions & 7 deletions

File tree

.github/PULL_REQUEST_TEMPLATE/developer.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,36 @@
11
## Overview
22

3-
3+
<!--
4+
One to two sentences.
5+
-->
46

7+
<!--
58
## Related
69
7-
<!--
810
- [DES-XYZ](https://tacc-main.atlassian.net/browse/DES-123)
911
- requires _some_other_pr_
1012
- required by _some_other_pr_
11-
-->
13+
-->
1214

1315
## Changes
1416

15-
17+
<!--
18+
- succinct list of changes that summarizes diff
19+
-->
1620

1721
## Testing
1822

19-
1.
23+
1.
2024

2125
## UI
2226

23-
27+
<!--
28+
| before | after |
29+
| - | - |
30+
| … | … |
31+
-->
2432

2533
<!--
2634
## Notes
2735
2836
29-
-->

0 commit comments

Comments
 (0)