Skip to content
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
82 changes: 57 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,70 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
title: '[Bug]: '
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
# Bug Report
<!-- A clear and concise description of the issue. -->

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
---

## To Reproduce
<!-- Provide the YAML configuration and the exact CLI command that reproduces the issue. -->

### YAML configuration
<!-- Paste the YAML file or the smallest excerpt that reproduces the issue.
Remove unrelated fields to make it minimal. -->
```yaml
# Paste the YAML snippet here
```

### CLI command used
<!-- Write the exact command used, for example: -->
```bash
# Paste the CLI command here
```

### Actual output
<!-- Paste the output, logs, or error messages here -->
```bash
# Paste the output, logs, or error messages here
```

### Expected output
<!-- Describe what you expected to see instead -->

---

**Expected behavior**
A clear and concise description of what you expected to happen.
## Environment and Versions

**Screenshots**
If applicable, add screenshots to help explain your problem.
- Operating System:
- Package Version:
- Python Version:
- Package list:
- If using conda, run: `conda list > packages.txt` and paste the contents here.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
``` bash
# Paste packages.txt here
```

- If using venv/pip, run: `pip list > packages.txt` and paste the contents here.

``` bash
# Paste packages.txt here
```

---

## Screenshots or Logs

<!-- Attach any relevant screenshots, logs, or stack traces. -->

---

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
## Additional Context

**Additional context**
Add any other context about the problem here.
<!-- Include anything else that might help reproduce or understand the bug, such as changes from a previously working version. -->
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
blank_issues_enabled: false
issue_templates:
- name: "Bug Report"
description: "Report a bug."
title: "[Bug]: "
labels: ["bug"]
body: "./ISSUE_TEMPLATE/bug_report.md"
- name: "Feature Request"
description: "Propose a new feature or improvement."
title: "[Feature]: "
labels: ["enhancement"]
body: "./ISSUE_TEMPLATE/feature_request.md"
- name: "Documentation"
description: "Suggest updates or additions to the documentation."
title: "[Docs]: "
labels: ["documentation"]
body: "./ISSUE_TEMPLATE/documentation.md"
- name: "General Report"
description: "Provide general feedback or inquiries."
title: "[General]: "
labels: ["general"]
body: "./ISSUE_TEMPLATE/general_report.md"
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Documentation
about: Suggest updates or additions to documentation
title: "[Docs]: "
labels: documentation
assignees: ''
---

### Documentation Update
<!-- What part of the documentation needs to be updated or added? -->

### Why Is This Needed?
<!-- Explain the importance of this update. -->

### Suggested Changes
<!-- Provide a detailed description of the changes. -->

### Additional Context
<!-- Include any related resources. -->
32 changes: 20 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
about: Suggest an idea
title: '[Feature]: '
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
# Feature Request

## Problem / Motivation
<!-- Describe the problem you want to solve or the motivation for this feature. -->

## Proposed Solution
<!-- Describe the feature you would like to see implemented. Include examples if applicable. -->

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
## Alternatives Considered
- <!-- Alternative 1 -->
- <!-- Alternative 2 -->

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
## Expected Impact
<!-- How this feature would affect the codebase or workflow -->
- <!-- Impact 1 -->
- <!-- Impact 2 -->

**Additional context**
Add any other context or screenshots about the feature request here.
## Additional Context
<!-- Add any other context, screenshots, or references for the feature request here. -->
- <!-- Further context -->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/general_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: General Report
about: Provide general feedback or inquiries
title: "[General]: "
labels: general
assignees: ''
---

### Feedback or Inquiry
<!-- Provide your feedback or inquiry. -->

### Additional Information
<!-- Add any other relevant details here. -->