Skip to content

Commit

Permalink
YAML based issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
parikshitbajpai committed Apr 18, 2024
1 parent bb0a004 commit 93c1d19
Show file tree
Hide file tree
Showing 4 changed files with 97 additions and 112 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

119 changes: 58 additions & 61 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -1,64 +1,61 @@
name: Bug Report
description: Create a report to help us improve
title: "[Bug]: "
labels: ["bug", "triage"]
projects: ["octo-org/1", "octo-org/44"]
assignees:
- octocat
description: Create a report to help us fix bugs
title: "[BUG] <title>"
labels: ["Bug", "Needs Triage"]
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@example.com
validations:
required: false
- 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:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
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)
default: 0
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
- 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
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Compiler**: gfortran 5.4.0
- **Python**: 3.12.0
value: |
- OS:
- Compiler:
- Python:
- Branch:
- Commit Hash:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature Request
description: Create a request for new features / enhancements
title: "[ENHANCEMENT] <title>"
labels: ["Enhancement", "Needs Triage"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue or PR for this?
description: Please search to see if an issue or PR already exists for the feature you are requesting.
options:
- label: I have searched the existing issues and PRs
required: true
- type: textarea
attributes:
label: Reasoning
description: A concise description of what you are interested in.
validations:
required: true
- type: textarea
attributes:
label: Proposed Solution
description: A concise description of what you want to happen and how it should be implemented.
validations:
required: false
- type: textarea
attributes:
label: Impact
description: A concise description of any consequences you can foresee.
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about your request!
Tip: You can attach images, etc. by clicking this area to highlight it and then dragging files in.
validations:
required: false

0 comments on commit 93c1d19

Please sign in to comment.