Skip to content

Commit 26b4e5f

Browse files
authored
Update pull_request_template.md
1 parent 520d25c commit 26b4e5f

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

Diff for: .github/pull_request_template.md

+49-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,50 @@
1+
<!--
2+
PR AUTHOR INSTRUCTIONS; PLEASE READ.
3+
4+
Give your pull request an accurate and descriptive title. It should mention what component(s) or database driver(s) it touches.
5+
Pull requests with undescriptive or inaccurate titles *may* be closed or have their titles changed before merging.
6+
7+
Fill out the fields below.
8+
9+
All pull requests *must* pass CI to be merged. Check your pull request frequently for build failures until all checks pass.
10+
Address build failures by pushing new commits or amending existing ones. Feel free to ask for help if you get stuck.
11+
If a failure seems spurious (timeout or cache failure), you may push a new commit to re-run it.
12+
13+
After addressing review comments, re-request review to show that you are ready for your PR to be looked at again.
14+
15+
Pull requests which sit for a long time with broken CI or unaddressed review comments will be closed to clear the backlog.
16+
If this happens, you are welcome to open a new pull request, but please be sure to address the feedback you have received previously.
17+
18+
Bug fixes should include a regression test which fails before the fix and passes afterwards. If this is infeasible, please explain why.
19+
20+
New features *should* include unit or integration tests in the appropriate folders. Database specific tests should go in `tests/<database>`.
21+
22+
Note that unsolicited pull requests implementing large or complex changes may not be reviwed right away.
23+
Maintainer time and energy is limited and massive unsolicited pull requests require an outsized effort to review.
24+
25+
To make the best use of your time and ours, search for and participate in existing discussion on the issue tracker before opening a pull request.
26+
The solution you came up with may have already been rejected or postponed due to other work needing to be done first,
27+
or there may be a pending solution going down a different direction that you hadn't considered.
28+
29+
Pull requests that take existing discussion into account are the most likely to be merged.
30+
31+
Delete this block comment before submission to show that you have read and understand these instructions.
32+
-->
33+
134
### Does your PR solve an issue?
2-
### Delete this text and add "fixes #(issue number)"
35+
Delete this text and add "fixes #(issue number)".
36+
37+
Do *not* just list issue numbers here as they will not be automatically closed on merging this pull request unless prefixed with "fixes" or "closes".
38+
39+
### Is this a breaking change?
40+
Delete this text and answer yes/no and explain.
41+
42+
If yes, this pull request will need to wait for the next major release (`0.{x + 1}.0`)
43+
44+
Behavior changes _can_ be breaking if significant enough.
45+
Consider [Hyrum's Law](https://www.hyrumslaw.com/):
46+
47+
> With a sufficient number of users of an API,
48+
> it does not matter what you promise in the contract:
49+
> all observable behaviors of your system
50+
> will be depended on by somebody.

0 commit comments

Comments
 (0)