Skip to content

Commit e5d48ce

Browse files
authored
Add Slight Improvements to PR Template (#1476)
* Comment out text that isn't expected to be included in the PR. - This clarifies what we expect the contributor to include. - This also prevents any irrelevant text from ending up in the PR and distracting reviewers. * Includes minor casing/spelling changes.
1 parent 3a4486a commit e5d48ce

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
## Corresponding issue (if exists):
1+
## Corresponding Issue(s): <!-- (if relevant) -->
22

3-
## What would you like to add/fix?
3+
## What Would You Like to Add/Fix?
44

55
## Todo
66

7-
- [ ] Add test that verifies the modified behavior
7+
- [ ] Add test(s) that verify the modified behavior
88
- [ ] Add documentation if it changes public API
99

10-
## Expectations on changes
10+
## Expectations on Changes
1111

12+
<!--
1213
1. Please don't do code changes and move code around in the same PR, even if you are making code better. Make sure the reviewer can see just the changes which fix the problem. This can make your Code Review much more accessible in complex situations; otherwise, it might never get merged even if it is correct because it's impossible to review without reimplementing every change.
1314
2. Often, submitting a failing test is more critical than the fix. Fixing the problem can be challenging and has many ways. Offering an excellent failing test is often 80% of the solution.
1415
3. Please review your PR before submitting it as if you are the reviewer. This way, you show respect for the maintainer's time.
16+
-->
1517

1618
## Changelog
1719

20+
<!--
1821
Please summarize the changes in a way that makes sense inside the changelog. Feel free to add migration tips or examples if necessary.
22+
-->

0 commit comments

Comments
 (0)