From cfb04b31dc6ac2177440d3691567ebee793c79e2 Mon Sep 17 00:00:00 2001 From: dcode Date: Wed, 27 May 2020 12:08:45 +0200 Subject: [PATCH 1/8] Add issue and PR templates, clarify guidelines --- .github/ISSUE_TEMPLATE.md | 4 ++++ .github/PULL_REQUEST_TEMPLATE.md | 4 ++++ CONTRIBUTING.md | 5 +++++ 3 files changed, 13 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..add367445b --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,4 @@ + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..8bab8c53f7 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,4 @@ + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0c25c19c2..fb6e81212a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,6 +35,7 @@ Submitting Pull Requests Instructions are similar to those for bug reports. Please provide the following information: +* Consider **creating an issue to discuss first** and **later link to it from the PR** if this is not a trivial fix. * Use a **clear and descriptive title** for the pull request. * Provide a **description of the suggested changes** in as many details as necessary. * **Document your new code** where necessary. @@ -47,3 +48,7 @@ Before submitting your pull request, please make sure that the following conditi * Your new code **passes all existing and new tests** through running `npm run test`. * Your PR **excludes distribution files** in `dist/**`. * You appended yourself to the **list of contributors** in the [NOTICE](./NOTICE) file. + +Please note that if a pull request is rather complicated, i.e. touches lots of internals, or became stale, it is not uncommon that a core contributor performs the final integration to get it done in good conscience while naming you as a co-author. + +Thank you! From 305a64fc482dbba3aae0753a83d8c01972c884c3 Mon Sep 17 00:00:00 2001 From: dcode Date: Wed, 27 May 2020 12:22:22 +0200 Subject: [PATCH 2/8] contribution -> contributing --- .github/ISSUE_TEMPLATE.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index add367445b..811128c33b 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8bab8c53f7..0df11db20c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ From ef81fd49d05fb8e1bd547fd63a5fe989e3083467 Mon Sep 17 00:00:00 2001 From: dcode Date: Thu, 28 May 2020 17:59:53 +0200 Subject: [PATCH 3/8] add a checkbox --- .github/ISSUE_TEMPLATE.md | 10 ++++++++-- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++++-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 811128c33b..12537f6802 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,10 @@ + +⯈ +⯈ +⯈ + +- [ ] I've read the contributing guidelines \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0df11db20c..ad286f4976 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,10 @@ + +⯈ +⯈ +⯈ + +- [ ] I've read the contributing guidelines \ No newline at end of file From 61150c4ab931eb015260614c109cf8e75a8dbdd9 Mon Sep 17 00:00:00 2001 From: dcode Date: Thu, 28 May 2020 18:01:02 +0200 Subject: [PATCH 4/8] maybe not on issues --- .github/ISSUE_TEMPLATE.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 12537f6802..27911d6c9c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,10 +1,4 @@ - -⯈ -⯈ -⯈ - -- [ ] I've read the contributing guidelines \ No newline at end of file From 7115c45e34ee23809ae7fb853c1efdd42a3295c5 Mon Sep 17 00:00:00 2001 From: dcode Date: Thu, 28 May 2020 18:08:13 +0200 Subject: [PATCH 5/8] keep the good start on issues --- .github/ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 27911d6c9c..6ed9129c68 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ From efc8657cf61d3cb8cdc6385577eff82d711d244b Mon Sep 17 00:00:00 2001 From: dcode Date: Thu, 28 May 2020 18:15:09 +0200 Subject: [PATCH 6/8] reorder --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb6e81212a..181378807b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,7 +35,7 @@ Submitting Pull Requests Instructions are similar to those for bug reports. Please provide the following information: -* Consider **creating an issue to discuss first** and **later link to it from the PR** if this is not a trivial fix. +* If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**. * Use a **clear and descriptive title** for the pull request. * Provide a **description of the suggested changes** in as many details as necessary. * **Document your new code** where necessary. From a623a330672e106b9ac727d2dfb45de5d1ed7300 Mon Sep 17 00:00:00 2001 From: dcode Date: Thu, 28 May 2020 18:28:53 +0200 Subject: [PATCH 7/8] reorder more --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 181378807b..4375cb32ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,16 +33,16 @@ Instructions are similar to those for bug reports. Please provide the following Submitting Pull Requests ------------------------ -Instructions are similar to those for bug reports. Please provide the following information: +Instructions are similar to those for bug reports: * If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**. * Use a **clear and descriptive title** for the pull request. -* Provide a **description of the suggested changes** in as many details as necessary. +* Provide a **description of the changes** in as many details as necessary. * **Document your new code** where necessary. * Please **refrain from refactoring (unrelated code)** as it makes your pull request easier to review. * **Create tests for your new code** where necessary. For creating or updating tests, please see the [Test Instructions](./tests). -Before submitting your pull request, please make sure that the following conditions are met: +Before submitting your pull request, also make sure that the following conditions are met: * Your new code **adheres to the code style** through running `npm run check`. * Your new code **passes all existing and new tests** through running `npm run test`. From 4ca2228d8b4ec8ffef1f38511a6602b579625745 Mon Sep 17 00:00:00 2001 From: dcode Date: Thu, 28 May 2020 18:38:04 +0200 Subject: [PATCH 8/8] a pre-flight issue can be considered information --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4375cb32ae..e903ed7941 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ Instructions are similar to those for bug reports. Please provide the following Submitting Pull Requests ------------------------ -Instructions are similar to those for bug reports: +Instructions are similar to those for bug reports. Please provide the following information: * If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**. * Use a **clear and descriptive title** for the pull request.