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 #595

Open
wants to merge 17 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
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/2-bugreport.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
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
Comment on lines +18 to +20
Copy link
Collaborator

Choose a reason for hiding this comment

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

The dropdown is nice but we'll also want the user to enter in a specific OS versions. Windows version 10, 11 server 2022 etc
macOS version Sonoma, Sequoia etc.
Linux distro+ version: Ubuntu, kali, mint, whatever else + version i.e Ubuntu 22.04 LTS

Maybe another text box for this information?

validations:
required: true
- type: input
attributes:
label: Python Version
description: Which Python version are you using?
placeholder: Enter your Python version (e.g., 3.10, 3.12)
validations:
required: true
- type: input
attributes:
label: PowerShell Version (optional)
Copy link
Collaborator

Choose a reason for hiding this comment

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

PowerShell?
This'll be nice for ScubaGear. Restrict options to PowerShell 5.1 and 7.0+
Don't think it needs to be here for Goggles.

description: Which PowerShell version are you using?
placeholder: Enter PowerShell version (e.g., 5.1, 7.0)
validations:
required: false
- type: textarea
attributes:
label: "\U0001F41B Summary"
description: What's wrong? Please be specific.
placeholder: This bug is resulting in an unexpected result in the reports...
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Using this environment...
2. Ran scubagoggles gws with these parameters...
3. Got this specific error output at this line number...
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: What did you expect to happen that didn't?
validations:
required: true
- type: textarea
attributes:
label: Any helpful log output or screenshots? (optional)
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
placeholder: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in."
validations:
required: false
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/baseline-content-policy-comment.md

This file was deleted.

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
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/🐛-bug-report.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/💡-idea.md

This file was deleted.