From e6cb0bb35427273287b159ae9a1c5308cd5e5c3f Mon Sep 17 00:00:00 2001 From: Hafez Date: Wed, 14 Sep 2022 05:03:03 +0200 Subject: [PATCH] fix: add PR instructions as comments to hide them in the actual PR --- PULL_REQUEST_TEMPLATE.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 3f410d4..3bc9822 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,11 @@ ## Proposed changes -Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue. + ## Types of changes -What types of changes does your code introduce to this repo? -_Put an `x` in the boxes that apply_ + - [ ] Bugfix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) @@ -15,7 +15,7 @@ _Put an `x` in the boxes that apply_ ## Checklist -_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ + - [ ] Lint and unit tests pass locally with my changes - [ ] I have added tests that prove my fix is effective or that my feature works @@ -24,10 +24,16 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating ## Screenshots -Before +
+ Before + +
-After +
+ After + +
## Further comments -If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... +