Skip to content

Commit c0ec44c

Browse files
committed
fix: improve clarity and grammar in pull request template
1 parent b8b432b commit c0ec44c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

.github/pull_request_template.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
<!-- Use this template by filling in information and copy and pasting relevant items out of the html comments. -->
1+
<!-- Use this template by filling in information and copying and pasting relevant items out of the HTML comments. -->
22

3-
# Relates to:
3+
# Relates to
44

55
<!-- LINK TO ISSUE OR TICKET -->
66

7-
<!-- This risks section is to be filled out before final review and merge. -->
7+
<!-- This risks section must be filled out before the final review and merge. -->
88

99
# Risks
1010

1111
<!--
12-
Low, medium, large. List what kind of risks, and what could be effected.
12+
Low, medium, large. List what kind of risks and what could be affected.
1313
-->
1414

1515
# Background
@@ -25,7 +25,7 @@ Features (non-breaking change which adds functionality)
2525
Updates (new versions of included code)
2626
-->
2727

28-
<!-- This "Why" section is most relevant if there is no linked issue explaining why. If there is a related issue it might make sense to skip this why section. -->
28+
<!-- This "Why" section is most relevant if there are no linked issues explaining why. If there is a related issue, it might make sense to skip this why section. -->
2929
<!--
3030
## Why are we doing this? Any context or related work?
3131
-->
@@ -35,10 +35,10 @@ Updates (new versions of included code)
3535
<!--
3636
My changes do not require a change to the project documentation.
3737
My changes require a change to the project documentation.
38-
If a docs change is needed: I have updated the documentation accordingly.
38+
If documentation change is needed: I have updated the documentation accordingly.
3939
-->
4040

41-
<!-- Please show how you tested the PR. This will really help if the PR needs to be retested, and probably help the PR get merged quicker. -->
41+
<!-- Please show how you tested the PR. This will really help if the PR needs to be retested and probably help the PR get merged quicker. -->
4242

4343
# Testing
4444

@@ -47,7 +47,7 @@ If a docs change is needed: I have updated the documentation accordingly.
4747
## Detailed testing steps
4848

4949
<!--
50-
None, automated tests are fine.
50+
None: Automated tests are acceptable.
5151
-->
5252

5353
<!--
@@ -63,22 +63,22 @@ None, automated tests are fine.
6363
### After
6464
-->
6565

66-
<!-- If there is anything about the deploy, please make a note. -->
66+
<!-- If there is anything about the deployment, please make a note. -->
6767
<!--
6868
# Deploy Notes
6969
-->
7070

71-
<!--  Copy and paste commandline output. -->
71+
<!--  Copy and paste command line output. -->
7272
<!--
7373
## Database changes
7474
-->
7575

76-
<!--  If there is something more than the automated steps, please specifiy deploy instructions. -->
76+
<!--  Please specify deploy instructions if there is something more than the automated steps. -->
7777
<!--
7878
## Deployment instructions
7979
-->
8080

81-
<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for contribute role and join us in #development-feed -->
81+
<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for the contributor role and join us in #development-feed -->
8282
<!--
8383
## Discord username
8484

0 commit comments

Comments
 (0)