From f77c3d8d4305a36a05be9d18750b61950b877f83 Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Wed, 23 Dec 2020 22:31:09 +0100 Subject: [PATCH] update PR template (#5206) Co-authored-by: Rohit Gupta (cherry picked from commit b22b1c2df25156f6d93eb3d8b3c85cf7b072e57e) --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++++- .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++----- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ddae1ea8a9..cef062516b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,11 +10,15 @@ assignees: '' -## Please reproduce using [the BoringModel and post here](https://colab.research.google.com/drive/1HvWVVTK8j2Nj52qU4Q4YCyzOm0_aLQF3?usp=sharing) +## Please reproduce using the BoringModel + ### To Reproduce + +Use following [**BoringModel**](https://colab.research.google.com/drive/1HvWVVTK8j2Nj52qU4Q4YCyzOm0_aLQF3?usp=sharing) and post here + ### Expected behavior diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4263a76fb1..c2ce4a5e8b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,11 @@ ## What does this PR do? -Fixes # (issue) +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) ## 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? Otherwise, we ask you to create a separate PR for every change. -- [ ] Did you make sure to update the documentation with your changes? -- [ ] Did you write any new necessary tests? +- [ ] 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)? @@ -28,7 +33,8 @@ Before you start reviewing make sure you have read [Review guidelines](https://g - [ ] 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; _Bugfixes should be including in bug-fix release milestones (m.f.X) and features should be included in (m.X.b) releases._ + - [ ] 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?