From ff41665e47369f90956a375e49e21443f3a324be Mon Sep 17 00:00:00 2001 From: Byron Zhu Date: Wed, 15 May 2019 11:36:11 -0400 Subject: [PATCH 1/5] Create pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 📝 add PR template --- .github/pull_request_template.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 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 0000000000..04081ae0a4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ +*Please edit the list to your PR scope, then check off the boxes as you go!* + +## Contributor Checklist + +- [ ] I have broken down my PR scope into the following TODO tasks + - [ ] task 1 + - [ ] task 2 +- [ ] I have passed with at least one python version with `circleci local execute` +- [ ] I have gotten :dancer: from my reviewer(s) + +### optionals + +- [ ] I have added entry in the `CHANGELOG.md` +- [ ] If this PR needs a follow-up in **dash docs**, **community thread**, I have mentioned the relevant URLS as follow + - [ ] this github [#PR number]() updates the dash docs + - [ ] here is the show and tell thread in plotly dash community + +## Reminder Checklist for reviewers + +* incorrect logic, bad usage, typos? +* style, bad coding practices? +* is the code hard to read/understand and will have maintainance issue? +* does the PR or the issue include enough information to understand what's being changed here? +* are there tests in the PR? are the tests reasonable? at the right level? + + + From ca9bcbf2f159b8fdbe9b50429e3d5d72527f65d7 Mon Sep 17 00:00:00 2001 From: Byron Zhu Date: Wed, 15 May 2019 11:48:22 -0400 Subject: [PATCH 2/5] Update pull_request_template.md add post-merge and ci jobs check --- .github/pull_request_template.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 04081ae0a4..bc81297a90 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,8 +6,12 @@ - [ ] task 1 - [ ] task 2 - [ ] I have passed with at least one python version with `circleci local execute` +- [ ] I have verified all the required circleci jobs are passed without warnings - [ ] I have gotten :dancer: from my reviewer(s) +## Post-merge Checklist +- [ ] I have clicked the `Delete Branch` button after merge + ### optionals - [ ] I have added entry in the `CHANGELOG.md` From 95d335786a1532533453b3e6bb25ceb2ae0cb725 Mon Sep 17 00:00:00 2001 From: Byron Zhu Date: Wed, 15 May 2019 15:39:22 -0400 Subject: [PATCH 3/5] Update pull_request_template.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 👌 🔪 --- .github/pull_request_template.md | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index bc81297a90..427a3eb28e 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,16 +1,11 @@ -*Please edit the list to your PR scope, then check off the boxes as you go!* +*Start with a description of this PR. Then edit the list below to the items that make sense for your PR scope, and check off the boxes as you go!* ## Contributor Checklist - [ ] I have broken down my PR scope into the following TODO tasks - [ ] task 1 - [ ] task 2 -- [ ] I have passed with at least one python version with `circleci local execute` -- [ ] I have verified all the required circleci jobs are passed without warnings -- [ ] I have gotten :dancer: from my reviewer(s) - -## Post-merge Checklist -- [ ] I have clicked the `Delete Branch` button after merge +- [ ] I have run the tests locally and they passed. (refer to testing section in [contributing](CONTRIBUTING.md)) ### optionals @@ -18,14 +13,3 @@ - [ ] If this PR needs a follow-up in **dash docs**, **community thread**, I have mentioned the relevant URLS as follow - [ ] this github [#PR number]() updates the dash docs - [ ] here is the show and tell thread in plotly dash community - -## Reminder Checklist for reviewers - -* incorrect logic, bad usage, typos? -* style, bad coding practices? -* is the code hard to read/understand and will have maintainance issue? -* does the PR or the issue include enough information to understand what's being changed here? -* are there tests in the PR? are the tests reasonable? at the right level? - - - From a32b7e7b54579dcf0d9bd9e68732ed62858c7dfc Mon Sep 17 00:00:00 2001 From: Byron Zhu Date: Wed, 15 May 2019 15:40:39 -0400 Subject: [PATCH 4/5] Update pull_request_template.md :bug: fix the contributing path --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 427a3eb28e..c63da911d2 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,7 +5,7 @@ - [ ] I have broken down my PR scope into the following TODO tasks - [ ] task 1 - [ ] task 2 -- [ ] I have run the tests locally and they passed. (refer to testing section in [contributing](CONTRIBUTING.md)) +- [ ] I have run the tests locally and they passed. (refer to testing section in [contributing](../CONTRIBUTING.md)) ### optionals From d7ffd223be3835542887bd1acb7191013299688a Mon Sep 17 00:00:00 2001 From: alexcjohnson Date: Thu, 16 May 2019 15:24:27 -0400 Subject: [PATCH 5/5] add new tests checkbox to PR template --- .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 c63da911d2..228cf09700 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,6 +6,7 @@ - [ ] task 1 - [ ] task 2 - [ ] I have run the tests locally and they passed. (refer to testing section in [contributing](../CONTRIBUTING.md)) +- [ ] I have added tests, or extended existing tests, to cover any new features or bugs fixed in this PR ### optionals