From 28501759fdaf8404c7cd9731a227b06a83578a87 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Tue, 17 Dec 2019 05:40:22 +0100 Subject: [PATCH 1/2] Improve GH issue template Add some additional guidance in an attempt to make sure that enough information will be added to issues to make them actionable. --- .github/ISSUE_TEMPLATE.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d816fba7..272cbfcd 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -13,7 +13,31 @@ ## Steps to reproduce > (How can someone else make/see it happen) +> +> (Please include any relevant links. Think: links to a branch in a repo where you are experiencing the problem +> which can be used to reproduce the issue, links to external standards you are using.) +> (Also, if relevant and if it can be used to reproduce the issue, please paste the contents of your `composer.json` +> file here. +> +> ```json +> (Content of the `composer.json` file) +> ``` ## Proposed changes > (If you have a proposed change, workaround or fix, describe the rationale behind it) + +## Environment + +| Question | Answer +| ------------------------| ------- +| OS | Windows/Linux/Mac (preferably with some version info) +| PHP version | x.y.z +| Composer version | x.y.z +| PHP_CodeSniffer version | x.y.z +| Dealerdirect PHPCS plugin version | x.y.z +| Install type | e.g. Composer global, Composer project local, other (please expand) + + +## Tested against `master` branch? +- [ ] I have verified the issue still exists in the `master` branch. From b33c868758a2ce4aa0a075ecf91ae7b42cceb61e Mon Sep 17 00:00:00 2001 From: jrfnl Date: Tue, 17 Dec 2019 05:55:11 +0100 Subject: [PATCH 2/2] Move the issue template Having a singular issue template named `.github/ISSUE_TEMPLATE.md` is using the legacy workflow from GitHub. GitHub nowadays recommends for issue templates to be placed in a `ISSUE_TEMPLATE` directory and use front matter, to allow for multiple descriptive issue templates. --- .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} | 6 ++++++ 1 file changed, 6 insertions(+) rename .github/{ISSUE_TEMPLATE.md => ISSUE_TEMPLATE/bug_report.md} (94%) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 94% rename from .github/ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE/bug_report.md index 272cbfcd..103f9300 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,3 +1,9 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + ## Problem/Motivation > (Why the issue was filed)