Skip to content

Commit

Permalink
Update issue templates (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
gromdimon authored Jan 17, 2025
1 parent dedd348 commit 02df943
Show file tree
Hide file tree
Showing 6 changed files with 153 additions and 68 deletions.
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 🐞 Bug Report
description: Create a report to help us improve
title: "[BUG] "
labels: ["bug", "triage"]
assignees: []
body:
- type: checkboxes
attributes:
label: Issue Search
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: textarea
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Run '...'
4. See error...
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Environment
description: |
Please provide details about your environment.
value: |
- OS:
- Python version:
- Package version:
render: markdown
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: |
Add any other context about the problem here. You can attach screenshots, logs, or any other relevant information by dragging files into this field.
validations:
required: false
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: 💡 Feature Request
description: Suggest an idea for this project
title: "[FEATURE] "
labels: ["feature", "enhancement"]
assignees: []
body:
- type: checkboxes
attributes:
label: Issue Search
description: Please search to see if this feature has already been suggested.
options:
- label: I have searched the existing feature requests
required: true

- type: textarea
attributes:
label: Problem Statement
description: Is your feature request related to a problem? Please describe.
placeholder: I'm always frustrated when [...]
validations:
required: true

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

- type: textarea
attributes:
label: Alternative Solutions
description: Describe any alternative solutions or features you've considered.
placeholder: A clear and concise description of any alternative solutions or features you've thought about.
validations:
required: false

- type: textarea
attributes:
label: Additional Context
description: |
Add any other context, screenshots, or examples about the feature request here.
Tip: You can attach images or documents by clicking this area to highlight it and then dragging files in.
validations:
required: false
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/misc.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/misc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 🔍 Other Issue
description: Report any other type of issue
title: "[OTHER] "
labels: ["misc"]
assignees: []
body:
- type: checkboxes
attributes:
label: Issue Type Verification
description: Please confirm this issue doesn't fit into other categories
options:
- label: I confirm this is not a bug report or feature request
required: true
- label: I have searched for similar issues
required: true

- type: dropdown
attributes:
label: Issue Category
description: What type of issue is this?
options:
- Documentation
- Performance
- Security
- Question
- Other
validations:
required: true

- type: textarea
attributes:
label: Issue Description
description: Please provide a clear and concise description of the issue
placeholder: Describe what you'd like to discuss or report...
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: |
Add any other context, screenshots, or relevant information about the issue here.
Tip: You can attach images or files by clicking this area to highlight it and then dragging files in.
validations:
required: false

0 comments on commit 02df943

Please sign in to comment.