Skip to content

Commit 9b21238

Browse files
authored
Add Expectations on changes section
1 parent 39bae76 commit 9b21238

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
- [ ] Add test that verifies the modified behavior
88
- [ ] Add documentation if it changes public API
99

10+
## Expectations on changes
11+
12+
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 PR reviewable 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.
13+
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.
14+
3. Please review your PR before submitting it as if you are the reviewer. This way, you show respect for the maintainer's time.
15+
1016
## Changelog
1117

1218
Please summarize the changes in a way that makes sense inside the changelog. Feel free to add migration tips or examples if necessary.

0 commit comments

Comments
 (0)