Skip to content

Commit c2bd7d9

Browse files
authored
minor: Add comment blocks to PR template (#8994)
So they don't show up by default on rendered view.
1 parent 6192718 commit c2bd7d9

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

.github/pull_request_template.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,38 @@
11
# Which issue does this PR close?
22

3+
<!--
34
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax.
5+
-->
46

57
- Closes #NNN.
68

79
# Rationale for this change
810

11+
<!--
912
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
1013
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
14+
-->
1115

1216
# What changes are included in this PR?
1317

18+
<!--
1419
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
20+
-->
1521

1622
# Are these changes tested?
1723

24+
<!--
1825
We typically require tests for all PRs in order to:
1926
1. Prevent the code from being accidentally broken by subsequent changes
2027
2. Serve as another way to document the expected behavior of the code
2128
2229
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
30+
-->
2331

2432
# Are there any user-facing changes?
2533

34+
<!--
2635
If there are user-facing changes then we may require documentation to be updated before approving the PR.
2736
2837
If there are any breaking changes to public APIs, please call them out.
38+
-->

0 commit comments

Comments
 (0)