From 67f74f082cc047c5cc1962d3587467498ba1b8c4 Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Sat, 5 May 2018 23:59:37 +0100 Subject: [PATCH 1/2] add more details --- .github/ISSUE_TEMPLATE.md | 32 -------------------------------- 1 file changed, 32 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 9aac57600..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,32 +0,0 @@ -Steps to reproduce ------------------- - -```powershell - -``` - -Expected behavior ------------------ - -```none - -``` - -Actual behavior ---------------- - -```none - -``` - -Environment data ----------------- - - - -```powershell -> $PSVersionTable - -> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() } - -``` From 719f9905947a65b591ca9ea48e8e8267f81eb91b Mon Sep 17 00:00:00 2001 From: Christoph Bergmeister Date: Sun, 6 May 2018 00:02:20 +0100 Subject: [PATCH 2/2] Use multiple issue templates for bugs, features requests and support questions. --- .github/ISSUE_TEMPLATE/Bug_report.md | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 18 +++++++++ .github/ISSUE_TEMPLATE/Support_Question.md | 9 +++++ 3 files changed, 72 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/Support_Question.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 000000000..3627f89eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,45 @@ +--- +name: Bug report 🐛 +about: Report errors or unexpected behavior 🤔 + +--- + +Before submitting a bug report: + +- Make sure you are able to repro it on the latest released version +- Perform a quick search for existing issues to check if this bug has already been reported + +Steps to reproduce +------------------ + +```PowerShell + +``` + +Expected behavior +----------------- + +```none + +``` + +Actual behavior +--------------- + +```none + +``` + +If an unexpected error was thrown then please report the full error details using e.g. `$error[0] | Select-Object *` + +Environment data +---------------- + + + +```PowerShell +> $PSVersionTable + +> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() } + +``` diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 000000000..1f2f67683 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,18 @@ +--- +name: Feature request/idea 🚀 +about: Suggest a new feature or improvement (this does not mean you have to implement it) + +--- + +**Summary of the new feature** + +A clear and concise description of what the problem is that the new feature would solve. +Try formulating it in user story style (if applicable): +'As a user I want X so that Y.' with X being the being the action and Y being the value of the action. + +**Proposed technical implementation details (optional)** + +A clear and concise description of what you want to happen. + +**What is the latest version of PSScriptAnalyzer at the point of writing** + diff --git a/.github/ISSUE_TEMPLATE/Support_Question.md b/.github/ISSUE_TEMPLATE/Support_Question.md new file mode 100644 index 000000000..655e3ce3e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support_Question.md @@ -0,0 +1,9 @@ +--- +name: Support Question ❓ +about: If you have a question, you can try asking in the scriptanalyzer channel of the international PowerShell Slack channel first. + +--- + +* Slack Community Chat: https://powershell.slack.com (you can sign-up at http://slack.poshcode.org/ for an invite) +* Also have a look at the `RoleDocumentation` folder for more information on each rule: +https://github.com/PowerShell/PSScriptAnalyzer/tree/development/RuleDocumentation \ No newline at end of file