Skip to content

Commit

Permalink
feat: Improved bug reporting & feature suggestion
Browse files Browse the repository at this point in the history
  • Loading branch information
mountaindude committed Mar 8, 2023
1 parent b0d1e74 commit 1122f27
Show file tree
Hide file tree
Showing 4 changed files with 146 additions and 53 deletions.
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: 🐞 Bug Report
description: Create a bug report for Butler Spyglass
labels: 'template: bug'
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- type: markdown
attributes:
value: 'Please first search the repository for similar issues and discussions.'
- type: input
attributes:
label: What version of Butler Spyglass are you using?
description: '`butler-spyglass.exe --version`. For example: 2.1.3'
validations:
required: true
- type: input
attributes:
label: What version of Node.js are you using? Not applicable if you use the standalone version of Butler Spyglass.
description: '`node --version` - For example: 16.0.0'
validations:
required: false
- type: input
attributes:
label: What command did you use to start Butler Spyglass?
description: 'Please include all parameters!'
validations:
required: true
- type: input
attributes:
label: What operating system are you using?
description: 'For example: macOS, Windows, Windows Server, Ubuntu 20.04, Docker'
validations:
required: true
- type: input
attributes:
label: What CPU architecture are you using?
description: 'For example: x86_64, arm64, armv7, Intel 12900K, Apple M1, Not sure'
validations:
required: true
- type: input
attributes:
label: What Qlik Sense versions are you using?
description: 'For example: 2021-November sp2'
validations:
required: true
- type: textarea
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior, please provide as clear as possible description. Screenshots can be provided in the issue body below.
validations:
required: false
- type: markdown
attributes:
value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- type: markdown
attributes:
value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- type: markdown
attributes:
value: The information you enter on this page will be used to improve and enhance this project. Thanks in advance!
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/02_regression.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: ⏮️ Regression report
description: Report a bug not seen in an earlier version of Butler Spyglass
labels: 'template: regression'
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
- type: markdown
attributes:
value: 'Please first search the repository for similar issues and discussions.'
- type: input
attributes:
label: What version of Butler Spyglass are you using?
description: '`Butler Spyglass.exe --version`. For example: 7.0.1'
validations:
required: true
- type: input
attributes:
label: Which version(s) of Butler Spyglass work for you?
description: '`Butler Spyglass.exe --version` - For example: 7.0.0'
validations:
required: true
- type: input
attributes:
label: What version of Node.js are you using? Not applicable if you use the standalone version of Butler Spyglass.
description: '`node --version` - For example: 16.0.0'
validations:
required: false
- type: input
attributes:
label: What operating system are you using?
description: 'For example: macOS, Windows, Windows Server, Ubuntu 20.04, Docker'
validations:
required: true
- type: input
attributes:
label: What CPU architecture are you using?
description: 'For example: x86_64, arm64, armv7, Intel 12900K, Apple M1, Not sure'
validations:
required: true
- type: input
attributes:
label: What Qlik Sense versions are you using?
description: 'For example: 2021-November sp2'
validations:
required: true
- type: textarea
attributes:
label: Describe the Bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior, please provide as clear as possible description. Screenshots can be provided in the issue body below.
validations:
required: true
- type: markdown
attributes:
value: Before posting the issue go through the steps you've written down to make sure the steps provided are detailed and clear.
- type: markdown
attributes:
value: Contributors should be able to follow the steps provided in order to reproduce the bug.
- type: markdown
attributes:
value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 1122f27

Please sign in to comment.