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

chore: add issue templates #173

Merged
merged 2 commits into from
Nov 6, 2024
Merged
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
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json

name: Bug Report
description: Report a bug
title: '[Bug] '
labels:
- bug
- triage
body:
- type: markdown
attributes:
value: Please tell us about the bug.
- type: dropdown
id: version
attributes:
label: Version
description: What version are you running?
options:
- v0.0.1
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Description
description: Describe what happened.
validations:
required: true
- type: textarea
id: bug-reproduce-steps
attributes:
label: Steps to reproduce
description: What are the exact steps needed to reproduce the bug you experienced?
value: |-
1.
validations:
required: true
- type: textarea
id: bug-expectations
attributes:
label: Expected behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
id: bug-screenshots
attributes:
label: Screenshots
description: >-
If you have any screenshots that would help, please paste them below.
GitHub allows you to copy-and-paste directly from the clipboard into the text area.
**Please avoid taking screenshots of either log or terminal output**; paste any textual output in the logs section below.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs
description: Please copy and paste any relevant log output.
render: Shell
- type: checkboxes
id: troubleshooting
attributes:
label: Troubleshooting
description: By submitting this issue, you agree that you have performed some basic attempts at researching and solving your problem.
options:
- label: I have searched other issues in this repository and mine is not recorded.
required: true
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json

name: Feature Request
description: Suggest a new feature
title: '[Feature] '
labels:
- enhancement
- triage
body:
- type: markdown
attributes:
value: Please explain the new feature.
- type: textarea
id: problem
attributes:
label: Problem Statement
description: Describe the problem.
placeholder: A clear and concise description of the problem statement.
validations:
required: true
- type: textarea
id: solution
attributes:
label: Solution Description
description: Describe the solution you'd like.
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe alternatives you've considered.
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: Any additional context to this enhancement request.
placeholder: Add any other context or screenshots about the feature request here.
validations:
required: false
- type: checkboxes
id: research
attributes:
label: Research
description: By submitting this issue, you agree that you have performed some basic attempts at researching your problem and solution.
options:
- label: I have searched other issues in this repository and mine is not recorded.
required: true
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/general-question.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# yaml-language-server: $schema=https://json.schemastore.org/github-issue-forms.json

name: General Question
description: Ask a question or need support
title: '[Question] '
labels:
- question
body:
- type: markdown
attributes:
value: Please answer these questions before submitting your issue. Thanks!
- type: textarea
id: describe-your-question
attributes:
label: Describe your question
description: Provide details about your question or the support needed.
placeholder: Type your question here...
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
description: What version are you running?
options:
- v0.0.1
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots about the question here.
placeholder: Additional details...
validations:
required: false
Loading