From 9c97633edc55c918d6da69dd0b3575e5a44b3964 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 25 Jun 2020 00:58:31 +0200 Subject: [PATCH 01/15] s/opening/processing We process, users opens. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 3debc831162d..bcbd8cba403b 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -9,7 +9,7 @@ assignees: '' Thank you for contributing to the [rubygems](https://github.com/rubygems/rubygems) repository, and specifically to the [Bundler](https://bundler.io/) gem. -Before processing your issue please confirm that: +Before opening your issue please confirm that: - [ ] You checked all the following documents and couldn't find a solution for your issue: From 350b53e70d27d7f697a3dd55da4faa12507ba381 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 25 Jun 2020 01:00:07 +0200 Subject: [PATCH 02/15] Merge initial and final section with something ligther All the information should be in the guide for filling issues. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index bcbd8cba403b..9de2554a6aee 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -9,16 +9,7 @@ assignees: '' Thank you for contributing to the [rubygems](https://github.com/rubygems/rubygems) repository, and specifically to the [Bundler](https://bundler.io/) gem. -Before opening your issue please confirm that: - -- [ ] You checked all the following documents and couldn't find a solution for your issue: - -- [Troubleshooting common issues](https://github.com/rubygems/rubygems/blob/master/bundler/doc/TROUBLESHOOTING.md) -- [Bundler documentation site](https://bundler.io/) -- [Bundler man pages](https://bundler.io/man/bundle.1.html) -- [Bundler command line reference](https://bundler.io/v2.0/commands.html) - -If you haven't done that, please do it before creating a new issue. +Before opening your issue, make sure you have checked [our filing issues guide](https://github.com/rubygems/rubygems/blob/master/bundler/doc/contributing/ISSUES.md). Please answer the following questions so we can process your issue as fast as possible: @@ -50,6 +41,4 @@ Please answer the following questions so we can process your issue as fast as po Your answer: -For more information please check [Filing Issues: a guide](https://github.com/rubygems/rubygems/blob/master/bundler/doc/contributing/ISSUES.md). - Thank you! From c55cbcd3fd14b9aa580aa37190539f12ada8a546 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 25 Jun 2020 01:01:24 +0200 Subject: [PATCH 03/15] Replace numbering with headers Otherwise it's really hard to discriminate questions from answers since none have any formatting. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 9de2554a6aee..ab142217e574 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -13,31 +13,31 @@ Before opening your issue, make sure you have checked [our filing issues guide]( Please answer the following questions so we can process your issue as fast as possible: -1. Do you have a reproduction script? It would be really helpful for us if you provide one. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). +### Do you have a reproduction script? It would be really helpful for us if you provide one. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). Script URL: -2. What are you trying to accomplish? +### What are you trying to accomplish? Your answer: -3. What command did you run? +### What command did you run? Your answer: -4. What were you expecting to happen? +### What were you expecting to happen? Your answer: -5. What actually happened? +### What actually happened? Your answer: -6. Is there an exception backtrace? If so, please copy it below. +### Is there an exception backtrace? If so, please copy it below. Your answer: -7. Please run `bundle env` and paste the output below: +### Please run `bundle env` and paste the output below: Your answer: From b30b0364a787e8e0f2cbd57bce3b168a2d054ccb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Thu, 25 Jun 2020 10:29:26 +0200 Subject: [PATCH 04/15] Hide welcome text So that the user still sees it, but doesn't creep into the final bug report. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index ab142217e574..cd0676d11c0a 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -7,12 +7,16 @@ assignees: '' --- + + ### Do you have a reproduction script? It would be really helpful for us if you provide one. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). Script URL: From a73c1b0d4b69319405600b7ff3dfc7eb810a3f88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:42:52 +0200 Subject: [PATCH 05/15] Remove duplicate thanks We already say this at the very beginning. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index cd0676d11c0a..e0594990062a 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -44,5 +44,3 @@ Please answer the following questions so we can process your issue as fast as po ### Please run `bundle env` and paste the output below: Your answer: - -Thank you! From 449f38f999f0fe704f0c06d1c262c3b291a661d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:45:19 +0200 Subject: [PATCH 06/15] Another minor rewording Not all of the sections are actual questions. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index e0594990062a..4997a12eb722 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -13,7 +13,7 @@ Thank you for contributing to the [rubygems](https://github.com/rubygems/rubygem Before opening your issue, make sure you have checked [our filing issues guide](https://github.com/rubygems/rubygems/blob/master/bundler/doc/contributing/ISSUES.md). -Please answer the following questions so we can process your issue as fast as possible: +Please fill in the following sections so we can process your issue as fast as possible: --> From a8f9ade8ac17d10a6ffeabfb14e6fd8ec1cf710b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:48:47 +0200 Subject: [PATCH 07/15] Reword section about reproduction steps In my opinion, this is the most important section. The previous wording makes it sound too much like it's not that important. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 4997a12eb722..4fc4eab8b2e8 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -17,7 +17,7 @@ Please fill in the following sections so we can process your issue as fast as po --> -### Do you have a reproduction script? It would be really helpful for us if you provide one. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). +### Post system independent steps to reproduce the problem. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). Script URL: From 3f5b90269adafc67dd679325ee3cdea5cee9ff33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:50:45 +0200 Subject: [PATCH 08/15] Add an initial section to describe the issue --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 4fc4eab8b2e8..1ee86a577614 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -17,6 +17,10 @@ Please fill in the following sections so we can process your issue as fast as po --> +### Describe the problem as clearly as you can + + Your anwser: + ### Post system independent steps to reproduce the problem. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). Script URL: From f9fdf34e1a8cf6fe0b751687ac40831e861778ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:51:03 +0200 Subject: [PATCH 09/15] Remove "What are you trying to accomplish?" question I believe it's too generic and the previous questions probably give enough information about user's intentions. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 1ee86a577614..8cdf418db843 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -25,10 +25,6 @@ Please fill in the following sections so we can process your issue as fast as po Script URL: -### What are you trying to accomplish? - - Your answer: - ### What command did you run? Your answer: From cc013ba8f32bb11bc86d1c8bb56a1ca4abbb206e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:54:49 +0200 Subject: [PATCH 10/15] Replace anwser placeholders Wrap them with `<-- .. -->` so that they don't appear in the final issue if they are not filled in, and replace them with some extra information that could be more useful. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 8cdf418db843..3d4ca525edc5 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -19,28 +19,28 @@ Please fill in the following sections so we can process your issue as fast as po ### Describe the problem as clearly as you can - Your anwser: + ### Post system independent steps to reproduce the problem. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). - Script URL: + ### What command did you run? - Your answer: + ### What were you expecting to happen? - Your answer: + ### What actually happened? - Your answer: + ### Is there an exception backtrace? If so, please copy it below. - Your answer: + ### Please run `bundle env` and paste the output below: - Your answer: + From c717a367714c191288a884be417b7ed6b2112ed2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:56:25 +0200 Subject: [PATCH 11/15] Remove unnecessary "exception backtrace" section The previous section already covers this. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 3d4ca525edc5..8b7e06bca0eb 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -37,10 +37,6 @@ Please fill in the following sections so we can process your issue as fast as po -### Is there an exception backtrace? If so, please copy it below. - - - ### Please run `bundle env` and paste the output below: From 9472661fde9d3c00586483585f063559bab59628 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:56:57 +0200 Subject: [PATCH 12/15] Reword section about `bundle env` Sometimes (in case of crashes), `bundler` will automatically run `bundle env` and print the output. In that case, we don't want the same information twice. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 8b7e06bca0eb..979409b44497 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -37,6 +37,6 @@ Please fill in the following sections so we can process your issue as fast as po -### Please run `bundle env` and paste the output below: +### If not included with the output of your command, run `bundle env` and paste the output below From 564e6bcdb52cc20ad020503ccd8eadbe51f4c9d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:57:48 +0200 Subject: [PATCH 13/15] Make repro steps section more concise Move the examples inside the placeholder, so the final issue never display them, since they are only useful for the OP, not for maintainers. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 979409b44497..0f4562e1589b 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -21,9 +21,14 @@ Please fill in the following sections so we can process your issue as fast as po -### Post system independent steps to reproduce the problem. Examples: [Sample repro script for Bundler issues](https://gist.github.com/xaviershay/6207550), [Another sample repro script for Bundler issues](https://gist.github.com/xaviershay/6295889). +### Post system independent steps to reproduce the problem - + ### What command did you run? From 1c155711fbd9aa6c6f55f140c161ef813f0e5c25 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 12:59:10 +0200 Subject: [PATCH 14/15] Use raw links for repro steps examples The link names are a bit dummy and don't add much. --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 0f4562e1589b..6e9ff8384167 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -26,7 +26,7 @@ Please fill in the following sections so we can process your issue as fast as po From b1973a3f14b0daaa5190fe3ab4e8cdb9585c0aed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Rodr=C3=ADguez?= Date: Fri, 3 Jul 2020 19:20:03 +0200 Subject: [PATCH 15/15] Fix typo Co-authored-by: Utkarsh Gupta --- .github/ISSUE_TEMPLATE/bundler-related-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bundler-related-issue.md b/.github/ISSUE_TEMPLATE/bundler-related-issue.md index 6e9ff8384167..36eb226fb860 100644 --- a/.github/ISSUE_TEMPLATE/bundler-related-issue.md +++ b/.github/ISSUE_TEMPLATE/bundler-related-issue.md @@ -30,7 +30,7 @@ Examples: https://gist.github.com/xaviershay/6207550, https://gist.github.com/xa --> -### What command did you run? +### Which command did you run?