lightning/.github/PULL_REQUEST_TEMPLATE.md

42 lines
2.4 KiB
Markdown
Raw Normal View History

## What does this PR do?
<!--
IMPORTANT:
We separated bug-fix PRs and feature PRs and they shall land in master and release/1.X-dev accordingly.
By default all PR are targeted to master which is correct for bug-fixes, but need to be change for features.
If you miss it we can still fix it for you, just ping us... :]
Please include a summary of the change and which issue is fixed.
Please also include relevant motivation and context.
List any dependencies that are required for this change.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.
-->
Fixes # (issue) <- this [links related issue to this PR](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
2020-10-21 08:32:40 +00:00
## Before submitting
- [ ] Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
- [ ] Did you read the [contributor guideline](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/.github/CONTRIBUTING.md), Pull Request section?
- [ ] Did you make sure your PR does only one thing, instead of bundling different changes together?
- [ ] Did you make sure to update the documentation with your changes [if needed]?
- [ ] Did you write any new necessary tests [no need for typos, docs]?
- [ ] Did you verify new and existing tests pass locally with your changes?
- [ ] If you made a notable change (that affects users), did you update the [CHANGELOG](https://github.com/PyTorchLightning/pytorch-lightning/blob/master/CHANGELOG.md)?
<!-- For CHANGELOG separate each item in the unreleased section by a blank line to reduce collisions -->
2020-10-21 08:32:40 +00:00
## PR review
Anyone in the community is free to review the PR once the tests have passed.
Before you start reviewing make sure you have read [Review guidelines](https://github.com/PyTorchLightning/pytorch-lightning/wiki/Review-guidelines). In short, see the following bullet-list:
2020-10-21 08:32:40 +00:00
- [ ] Is this pull request ready for review? (if not, please submit in draft mode)
- [ ] Check that all items from **Before submitting** are resolved
- [ ] Make sure the title is self-explanatory and the description concisely explains the PR
- [ ] Add labels and milestones (and optionally projects) to the PR so it can be classified
- [ ] **Check that target branch and milestone are aligned!**
## Did you have fun?
Make sure you had fun coding 🙃