Skip to content

Commit

Permalink
docs: clean up issue tempalates
Browse files Browse the repository at this point in the history
Clean up issue templates other than upload.yml, which will be dealt
with later.
  • Loading branch information
wd15 committed May 6, 2022
1 parent 57fd95f commit e09e40a
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 28 deletions.
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/blank.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: Blank Issue
about: Create an issue without a template
---
31 changes: 3 additions & 28 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,14 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
labels: ["bug"]
assignees:
- octocat
- wd15
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. [email protected]
validations:
required: false
- type: textarea
id: what-happened
attributes:
Expand All @@ -26,16 +18,6 @@ body:
value: "A bug happened!"
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version of our software are you running?
options:
- 1.0.2 (Default)
- 1.0.3 (Edge)
validations:
required: true
- type: dropdown
id: browsers
attributes:
Expand All @@ -46,17 +28,10 @@ body:
- Chrome
- Safari
- Microsoft Edge
- N/A
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
name: Feature Request
description: Suggest an idea to help improve PFHub
title: "[Feature]: "
labels: "enhancement"

body:
- type: markdown
attributes:
value: |
**Thanks for taking the time to fill out this feature request
report!** We kindly ask that you search to see if an issue
[already exists](https://github.com/usnistgov/pfhub/issues)
for your feature.
We are also happy to accept contributions from our users. For
more details see
[here](https://github.com/usnistgov/pfhub/blob/master/DEVELOPMENT.md).
- type: textarea
attributes:
label: Description
description: |
A clear and concise description of the feature you're interested in.
validations:
required: true

- type: textarea
attributes:
label: Suggested Solution
description: |
Describe the solution you'd like. A clear and concise description of what you want to happen.
validations:
required: true

- type: textarea
attributes:
label: Alternatives
description: |
Describe alternatives you've considered.
A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false

- type: textarea
attributes:
label: Additional Context
description: |
Add any other context about the problem here.
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/web_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
assignees:
- wd15
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: dropdown
id: browsers
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- N/A
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

0 comments on commit e09e40a

Please sign in to comment.