forked from twisted/twisted
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathPULL_REQUEST_TEMPLATE
25 lines (16 loc) · 1.28 KB
/
PULL_REQUEST_TEMPLATE
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
## Scope and purpose
Fixes #<!-- ISSUE-ID -->
Add a few words about why this PR is needed and what is its scope.
If the associate ticket(s) fully explain the need you can just refer to it/them.
Add any comments about trade-offs (if any) made in this PR and the reasoning behind them.
Add mentions of things that are not covered here and are planed to be done in separate PRs.
## Contributor Checklist:
This process applies to *all* pull requests - no matter how small.
Have a look at [our developer documentation](https://docs.twisted.org/en/latest/core/development/dev-process.html) before submitting your Pull Request.
Below is a non-exhaustive list (as a reminder):
* The title of the PR should describe the changes and starts with the associated issue number, like “#1234 Brief description”.
* A release notes news fragment file was create in src/twisted/newsfragments/ (see: [Release notes fragments docs.](https://docs.twisted.org/en/latest/core/development/dev-process.html#release-notes-management))
* The automated tests were updated.
* Once all checks are green, request a review by leaving a comment that contains exactly the string `please review`.
Our bot will trigger the review process, by applying the pending review label
and requesting a review from the Twisted dev team.