From 1c732f45069979261bdf875180eda42330ec3e6d Mon Sep 17 00:00:00 2001 From: JB Rubinovitz Date: Fri, 11 Dec 2020 21:32:55 -0800 Subject: [PATCH 1/4] docs(prs) add pull request template --- PULL_REQUEST_TEMPLATE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..26125c12 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ +## PR Description + + +## PR Checklist + +### Testing +- [ ] added relevant test coverage +- [ ] no tests needed + +### Docs +- [ ] added relevant docs +- [ ] update relevant sections in the README.md +- [ ] no docs needed + +### Typescript +- [ ] add or edit relevant Typescript type declarations +- [ ] no type declaration updates needed From 5b733452165739a52e01ec3d5fef30934972f9bb Mon Sep 17 00:00:00 2001 From: JB Rubinovitz Date: Fri, 11 Dec 2020 21:36:09 -0800 Subject: [PATCH 2/4] make tenses match PULL_REQUEST_TEMPLATE --- PULL_REQUEST_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 26125c12..3d509b99 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -9,9 +9,9 @@ ### Docs - [ ] added relevant docs -- [ ] update relevant sections in the README.md +- [ ] updated relevant sections in the README.md - [ ] no docs needed ### Typescript -- [ ] add or edit relevant Typescript type declarations +- [ ] added or edited relevant Typescript type declarations - [ ] no type declaration updates needed From 3cb344a4c26a12aa5074d3c5b1169e095e67e2db Mon Sep 17 00:00:00 2001 From: JB Rubinovitz Date: Fri, 18 Dec 2020 16:17:05 -0800 Subject: [PATCH 3/4] move template to .github --- PULL_REQUEST_TEMPLATE.md => .github/pull_request_template.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename PULL_REQUEST_TEMPLATE.md => .github/pull_request_template.md (100%) diff --git a/PULL_REQUEST_TEMPLATE.md b/.github/pull_request_template.md similarity index 100% rename from PULL_REQUEST_TEMPLATE.md rename to .github/pull_request_template.md From ea4b950770a55c1e47e649760562d47b3b739e20 Mon Sep 17 00:00:00 2001 From: JB Rubinovitz Date: Fri, 18 Dec 2020 16:23:24 -0800 Subject: [PATCH 4/4] add docstrings to checklist --- .github/pull_request_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 3d509b99..68d44a16 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,6 +10,7 @@ ### Docs - [ ] added relevant docs - [ ] updated relevant sections in the README.md +- [ ] updated relevant docstrings in index.d.ts - [ ] no docs needed ### Typescript