Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated bug and feature request templates #6

Merged
merged 3 commits into from
Sep 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
name: Bug Report
description: File a bug report
labels: ["bug"]
assignees:
- rebelinux
body:
- type: textarea
id: bug-description
attributes:
label: Bug description
description: >-
Please provide a clear and concise description of the bug.
validations:
required: true
- type: input
id: command-line-input
attributes:
label: Command-line input
description: >-
Please provide the command line input you are using to run AsBuiltReport. Please ensure that you obscure any sensitive information.
placeholder: New-AsBuiltReport -Report VMware.AppVolumes -Target xxxxxxx -Format Word,HTML -OutputFolderPath .\Documents\ -AsBuiltConfigFilePath .\AsBuiltReport\AsBuiltReport.json -ReportConfigFilePath .\AsBuiltReport\AsBuiltReport.VMware.AppVolumes.json -EnableHealthCheck -Verbose
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: >-
Please provide a detailed list of steps to reproduce the bug.
placeholder: |-
1. ....
2. ....
3. ....
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
description: >-
Please provide a clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: >-
Please attach any screenshots to help explain the problem. Please ensure that you obscure any sensitive information.
placeholder: |-
Drag and drop screenshots here.
- type: textarea
id: operating-system
attributes:
label: Operating System
description: Please provide information about the operating system are you using.
placeholder: macOS Big Sur, Windows 10, Ubuntu 20.04 LTS
validations:
required: true
- type: textarea
id: powershell-version
attributes:
label: PowerShell Version
description: Please provide information about the PowerShell version you are using. Please provide the output from the following PowerShell command `$PSVersionTable`.
placeholder: $PSVersionTable
validations:
required: true
- type: textarea
id: powershell-modules
attributes:
label: PowerShell Modules
description: Please provide information about the PowerShell modules are you using. Please provide the output from the following PowerShell command `Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.AppVolumes";"PScribo") | Select Name, Version`
placeholder: Get-Module -ListAvailable @("AsBuiltReport.Core";"AsBuiltReport.VMware.AppVolumes";"PScribo") | Select Name, Version
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: This field is optional. You may provide additional context for the bug you wish to report. You may wish to include links to any related [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.AppVolumes/issues) or other relevant information.
- type: checkboxes
id: checklist
attributes:
label: Before submitting
description: >-
Please ensure your bug report fulfills all of the following requirements.
If you are unsure of what a specific requirement means, please follow the links to learn about it and understand why it is necessary before submitting.
options:
- label: >-
I have read and followed the [bug reporting guidelines](https://www.asbuiltreport.com/about/contributing/#reporting-issues-and-bugs).
required: true
- label: >-
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this bug report.
required: true
- label: >-
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.AppVolumes/issues) before submitting this bug report.
required: true
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/change_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Change Request
description: Request a new change or an improvement
labels: ["change request"]
assignees:
- rebelinux
body:
- type: textarea
id: description
attributes:
label: Description
description: >-
Please provide a detailed description of your idea so that the project maintainers and contributors can fully understand what change, feature, or improvement you are proposing.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional Context
description: This field is optional. You may provide additional context for the idea you wish to propose. You may wish to include links to any related [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.AppVolumes/issues) or other relevant information.
- type: checkboxes
id: checklist
attributes:
label: Before submitting
description: >-
Please ensure your change request fulfills all of the following requirements.
If you are unsure of what a specific requirement means, please follow the links to learn about it and understand why it is necessary before submitting.
options:
- label: >-
I have read [the documentation](https://www.asbuiltreport.com/user-guide/new-asbuiltconfig),
and referred to the [known issues](https://www.asbuiltreport.com/user-guide/known-issues/) before submitting this change request.
required: true
- label: >-
I have checked for previously opened & closed [issues](https://github.com/AsBuiltReport/AsBuiltReport.VMware.AppVolumes/issues) before submitting this change request.
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/PSScriptAnalyzer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ jobs:
name: Run PSScriptAnalyzer
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: lint
uses: devblackops/github-action-psscriptanalyzer@master
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
publish-to-gallery:
runs-on: windows-2019
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set PSRepository to Trusted for PowerShell Gallery
shell: pwsh
run: |
Expand Down