Skip to content

Commit 23b9d6d

Browse files
authored
docs: comment instructions for PR template (#1710)
* docs: comment instructions for PR template Updated the pull request template to include comment descriptions for each section. * Update pull request template for clarity Clarify the purpose of the summary section in the pull request template. * docs: reduce verbosity of UI section * docs: remove excess punctuation & syntax Ending heading with hashes is redundant. Heading text needs no colon; colon is for content text that introduces more content. * docs: reduce all comments to one line
1 parent c395f0d commit 23b9d6d

1 file changed

Lines changed: 25 additions & 8 deletions

File tree

.github/pull_request_template.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,37 @@
1-
## Overview: ##
1+
## Overview
22

3-
## PR Status: ##
3+
<!--
4+
1–3 sentences stating what problem this solves and what you changed at a high level. Example: "Adds/Fixes X, when Y, via Z."
5+
-->
6+
7+
## PR Status
48

59
* [X] Ready.
610
* [ ] Work in Progress.
711
* [ ] Hold.
812

9-
## Related Jira tickets: ##
13+
## Related Links
1014

1115
* [DES-XXXX](https://tacc-main.atlassian.net/browse/DES-XXXX)
1216

13-
## Summary of Changes: ##
17+
## Summary of Changes
18+
19+
<!--
20+
Details (perhaps excluded from the simpler overview) that may be clearer as text than reading the diff.
21+
-->
22+
23+
## Testing Steps
24+
25+
1.
26+
27+
## UI
1428

15-
## Testing Steps: ##
16-
1.
29+
<!--
30+
Any screenshots or videos to illustrate the change: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files
31+
-->
1732

18-
## UI Photos:
33+
## Notes
1934

20-
## Notes: ##
35+
<!--
36+
Optional: gotchas, known limitations, further context, etc.
37+
-->

0 commit comments

Comments
 (0)