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

Add GitHub Issue templates #415

Open
wants to merge 1 commit 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
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: "🐛 Bug Report"
description: Report a reproducible bug or regression.
title: "[Bug]: "
labels: ["Type: Bug", "Status: Triage"]
body:
- type: textarea
id: description
attributes:
label: What is the issue?
description: What happened? What did you expect to happen?
validations:
required: true
- type: dropdown
id: os
attributes:
label: OS
description: Which operating system are you using?
multiple: true
options:
- Linux
- macOS
- Windows
- Docker
- WSL2
- Other
validations:
required: false
- type: dropdown
id: gpu
attributes:
label: GPU
description: Which GPU(s) are you using?
multiple: true
options:
- Nvidia
- AMD
- Intel
- Apple
- Other
validations:
required: false
- type: dropdown
id: cpu
attributes:
label: CPU
description: Which CPU(s) are you using?
multiple: true
options:
- Intel
- AMD
- Apple
- Other
validations:
required: false
- type: textarea
id: system-other
attributes:
label: Additional System Information
description: Any other system information you would like to share that might be relevant to the bug.
placeholder: e.g., software versions, configurations, GPU models, VRAM, etc.
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs or Console Output
description: Paste any relevant logs or console output here (**DO NOT INCLUDE PRIVATE INFORMATION**).
placeholder: "Error messages, warnings, etc."
validations:
required: false
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: "✨ Feature Request"
description: Suggest new features for consideration.
title: "[Request]: "
labels: ["Type: Idea"]
body:
- type: textarea
id: feature
attributes:
label: What would you like?
description: A clear description of the feature or enhancement.
placeholder: I'd like to be able to...
validations:
required: true
- type: textarea
id: reason
attributes:
label: Why is this needed?
description: A clear description of why this would be useful to have.
placeholder: I want this because...
- type: textarea
id: other
attributes:
label: Other information
placeholder: Any other details?
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/9-help-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: "🤔 Questions and Help"
description: Ask a general support question.
title: "[Question]: "
labels: ["Type: Support"]
body:
- type: textarea
id: question
attributes:
label: Question
description: Describe your question or the issue you're facing.
placeholder: "How can I..."
validations:
required: true
- type: dropdown
id: os
attributes:
label: OS
description: Which operating system are you using?
multiple: true
options:
- Linux
- macOS
- Windows
- Docker
- WSL2
- Other
validations:
required: false
- type: dropdown
id: gpu
attributes:
label: GPU
description: Which GPU(s) are you using?
multiple: true
options:
- Nvidia
- AMD
- Intel
- Apple
- Other
validations:
required: false
- type: dropdown
id: cpu
attributes:
label: CPU
description: Which CPU(s) are you using?
multiple: true
options:
- Intel
- AMD
- Apple
- Other
validations:
required: false
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Provide a general summary of your changes in the title above. -->

# Description
<!--
What do you want to achieve with this PR? Why did you write this code? What problem does this PR solve?
Describe your changes in detail and, if relevant, explain which choices you have made and why.
-->

## Related issues/external references
<!--
Format issues on GitHub as `#XXX`.
-->

## Types of changes
<!-- What types of changes does your code introduce? Remove all the items that do not apply: -->
- Bug fix _(non-breaking change which fixes an issue)_
- New feature _(non-breaking change which adds functionality)_
- Breaking change _(fix or feature that would cause existing functionality to change)_
- Documentation improvement
- Style _(Change that do not affect the functionality of the code)_
- CI/CD _(Changes to the CI/CD configuration)_