From d0e62a57ab6e2682e7c3baf64738600980718380 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sun, 3 Nov 2019 15:15:23 -0800 Subject: [PATCH 1/4] fix PR template to mention recommendatory nature of CC and DS --- .github/PULL_REQUEST_TEMPLATE.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 74975611dc..916f77b041 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,17 @@ -* [ ] Have you followed the guidelines in our - [Contributing document](https://dvc.org/doc/user-guide/contributing/core)? +* [ ] ❗ Have you followed the guidelines in the + [Contributing to DVC](https://dvc.org/doc/user-guide/contributing/core) + list? -* [ ] Does your PR affect documented changes or does it add new functionality - that should be documented? If yes, have you created a PR for - [dvc.org](https://github.com/iterative/dvc.org) documenting it or at - least opened an issue for it? If so, please add a link to it. +* [ ] 📖 This PR does _not_ require [documentation](https://dvc.org/doc) updates + or modifications. If it _does_, have you created a PR for + [dvc.org](https://github.com/iterative/dvc.org) or at least opened an + issue for it? If so, please add a link to it and after that check this + box. + +* [ ] ❌ Have you checked DeepSource, CodeClimate, and other sanity checks + below? Their findings are considered recommendatory. We don't expect all + of them to be fixed. Please, read them carefully and fix those that + actually improve code and/or fix bugs. + +Thank you for the contribution - we'll try to review it as soon as possible 🙏. ------ From 60bdd41cbd3374a761700bce2b92e088f4c7c31b Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sun, 3 Nov 2019 16:17:23 -0800 Subject: [PATCH 2/4] PR template: address review, update DS and CC checks item --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 916f77b041..55bc950f6c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,9 +9,9 @@ box. * [ ] ❌ Have you checked DeepSource, CodeClimate, and other sanity checks - below? Their findings are considered recommendatory. We don't expect all - of them to be fixed. Please, read them carefully and fix those that - actually improve code and/or fix bugs. + below? We consider their findings recommendatory and don't expect + everything to be addresses. Please review them carefully and fix those + that actually improve code or fix bugs. Thank you for the contribution - we'll try to review it as soon as possible 🙏. From 8b05eb5d3633432060095f608fdc8073848fd415 Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sun, 3 Nov 2019 16:19:05 -0800 Subject: [PATCH 3/4] PR template: minor sentence with emoji style change --- .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 55bc950f6c..6064756b21 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,5 +13,5 @@ everything to be addresses. Please review them carefully and fix those that actually improve code or fix bugs. -Thank you for the contribution - we'll try to review it as soon as possible 🙏. +Thank you for the contribution - we'll try to review it as soon as possible. 🙏 From cbb58e02d6c04950f9eb900e5a14d7cc6baa14ab Mon Sep 17 00:00:00 2001 From: Ivan Shcheklein Date: Sun, 3 Nov 2019 17:02:11 -0800 Subject: [PATCH 4/4] PR template: change wording for the docs checkbox --- .github/PULL_REQUEST_TEMPLATE.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6064756b21..92da7b4003 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,11 +2,13 @@ [Contributing to DVC](https://dvc.org/doc/user-guide/contributing/core) list? -* [ ] 📖 This PR does _not_ require [documentation](https://dvc.org/doc) updates - or modifications. If it _does_, have you created a PR for - [dvc.org](https://github.com/iterative/dvc.org) or at least opened an - issue for it? If so, please add a link to it and after that check this - box. +* [ ] 📖 Check this box if this PR **does not** require + [documentation](https://dvc.org/doc) updates, or if it does **and** you + have created a separate PR in + [dvc.org](https://github.com/iterative/dvc.org) + with such updates (or at least opened an issue about it in that repo). + Please link below to your PR (or issue) in the + [dvc.org](https://github.com/iterative/dvc.org) repo. * [ ] ❌ Have you checked DeepSource, CodeClimate, and other sanity checks below? We consider their findings recommendatory and don't expect