From 1adc0ab34d8f2d761711eb441d93c115261d98ef Mon Sep 17 00:00:00 2001 From: Bernie White Date: Sun, 1 Oct 2023 15:39:28 +1000 Subject: [PATCH] Updated issue forms (#2454) --- .github/ISSUE_TEMPLATE/bug-report.md | 4 +- .github/ISSUE_TEMPLATE/bug-report.yaml | 57 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yaml | 23 +++++++++ 3 files changed, 82 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 47b79fbc89b..9aefa91fa76 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Report errors or unexpected behaviour +about: Report errors or unexpected behavior labels: 'bug', 'Needs: Triage :mag:' --- @@ -31,7 +31,7 @@ Steps to reproduce the issue: **Module in use and version:** - Module: PSRule.Rules.Azure -- Version: **[e.g. 1.24.0]** +- Version: **[e.g. 1.29.0]** Captured output from `$PSVersionTable`: diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000000..cc5b48de883 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,57 @@ +name: Bug report +description: Report errors or unexpected behavior +title: '[BUG] ' +labels: ['bug', 'Needs: Triage :mag:'] +body: + - type: input + id: name + attributes: + label: Existing rule + description: If this relates to an existing rule include the name of the rule. + placeholder: Azure. + validations: + required: false + - type: textarea + attributes: + label: Description of the issue + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Error messages + description: If an error message is generated by the output please provide it here. + validations: + required: false + - type: textarea + attributes: + label: Reproduction + description: | + How can we reproduce the issue. + Please provide examples of the input or pipelines you are using that are failing. + For example, if expansion is failing please provide a Bicep example that demonstrates the issue so we can reproduce the issue. + validations: + required: true + - type: input + id: psrule + attributes: + label: Version of PSRule + description: Please provide the version of PSRule you are using. + value: '2.9.0' + validations: + required: false + - type: input + id: version + attributes: + label: Version of PSRule for Azure + description: Please provide the module version of PSRule for Azure you are using. + placeholder: '1.x.x' + validations: + required: false + - type: textarea + attributes: + label: Additional context + description: | + Any additional context relating to the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000000..47919bb40ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,23 @@ +name: Feature request +description: Suggest an idea +title: '[FEATURE] <title>' +labels: ['enhancement', 'Needs: Triage :mag:'] +body: + - type: textarea + attributes: + label: Your suggestion + description: A clear and concise description of the solution or improvement you would like. + validations: + required: true + - type: textarea + attributes: + label: Alternatives + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true + - type: textarea + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here. + validations: + required: false