From bf942b21b15a1ed3246c431d7cee037692a02115 Mon Sep 17 00:00:00 2001 From: Saurav Maheshkar Date: Sun, 27 Nov 2022 18:28:20 +0530 Subject: [PATCH 1/2] misc: create a PR template Fixes #51 --- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..87d865f2 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,20 @@ +## What does this PR do? + + + +Fixes `#` + +### Checklist + +- [ ] This change is discussed in a Github **issue/discussion** (`#`). +- [ ] Did you **document** your changes? (if necessary) +- [ ] Did you write any **new necessary high-coverage tests**? +- [ ] Did you verify new and **existing tests pass** locally with your changes? + +### PR Review + + + +Reviewers: + +### Any Other Comments From 6950d96b4e3ec90b1c81c7a371ca893a76ed64c5 Mon Sep 17 00:00:00 2001 From: Saurav Maheshkar Date: Mon, 28 Nov 2022 16:09:38 +0530 Subject: [PATCH 2/2] misc: add doc strings and type hints to the PR template cc: @mateibejan1 --- .github/PULL_REQUEST_TEMPLATE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 87d865f2..b7a06861 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,6 +8,8 @@ Fixes `#` - [ ] This change is discussed in a Github **issue/discussion** (`#`). - [ ] Did you **document** your changes? (if necessary) +- [ ] Have you **documented (doc strings)** your code ? (if necessary) +- [ ] Have you added type hints to your code ? (if necessary) - [ ] Did you write any **new necessary high-coverage tests**? - [ ] Did you verify new and **existing tests pass** locally with your changes?