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

Convert issue templates in markdown to GitHub's issue forms #1562

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/1-newidea.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: "\U0001F4A1 Submit a feature request / idea"
description: Describe an idea, todo, feature, task, improvement, issue, epic, or story
labels:
- enhancement

body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: This issue has an informative and human-readable title.
required: true
- type: textarea
attributes:
label: "\U0001F4A1 Summary"
description: What is the work, as a high-level summary?
placeholder: |
The purpose of this issue is to accomplish x task for y reason...
validations:
required: true
- type: textarea
attributes:
label: Motivation and context
description: Why does this work belong in this project?
placeholder: |
This would be useful because...
validations:
required: true
- type: textarea
attributes:
label: Implementation notes
description: Please provide details for implementation.
placeholder: |
1. An example for how this would be used
2. What would this look like
3. How this would act
4. Any related work, including links to related issues
validations:
required: true
- type: textarea
attributes:
label: Acceptance criteria (optional)
description: How do we know when this work is done?
placeholder: |
- [ ] The new feature is fully implemented based on x, y, z criteria
- [ ] Additional unit test coverage is added
- [ ] Any other criteria
validations:
required: false
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bugreport.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: "\U0001F41B Bug report"
description: Describe a bug, error, unexpected behavior, or other problem
labels:
- bug

body:
- type: checkboxes
attributes:
label: Prerequisites
options:
- label: This issue has an informative and human-readable title.
required: true
- type: dropdown
attributes:
label: Operating System
description: Which operating system are you using?
options:
- Windows
- macOS
- Linux
validations:
required: true
- type: input
attributes:
label: PowerShell Version
description: Which PowerShell version are you using?
placeholder: Enter PowerShell version (e.g., 5.1, 7.0)
validations:
required: true
- type: textarea
Comment on lines +29 to +30
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add ScubaGear version to bug report.

Suggested change
required: true
- type: textarea
required: true
- type: textarea
attributes:
label: "ScubaGear Version"
description: Please indicate the version of ScubaGear being run.
placeholder: Run Invoke-SCuBA -Version locally and paste output here to ensure correct version is indicated.
validations:
required: true
- type: textarea

attributes:
label: "\U0001F41B Summary"
description: What's wrong? Please be specific.
placeholder: Seeing unexpected results in the reports...
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Do this
2. Then this
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: What did you expect to happen that didn't?
validations:
required: true
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest adding another optional field here to capture the output from Initialize-SCuBA. Doing so has the following value:

  1. This verifies it has been run and gets rid of issues around uninstalled or incorrect version installs of dependencies.
  2. Whether it installs anything new, it confirms the versions of each dependency in use, helping identify issues with bugged dependency module versions.
  3. It's easy to collect by users and is fairly general information. The only exception being it might identify their username in the OPA install path.
Suggested change
required: true
required: true
- type: textarea
attributes:
label: Output from Initialize-SCuBA
description: |
Paste the results here:
placeholder: "Tip: Run Initialize-SCuBA on the client where you are running ScubaGear and copy/paste the output here."
validations:
required: false

- type: textarea
attributes:
label: Any helpful log output or screenshots? (optional)
description: |
Paste the results here:
placeholder: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in."
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
Loading