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

Adding GH Issue Templates #97

Merged
merged 8 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
83 changes: 27 additions & 56 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,67 +9,38 @@ body:
value: |
Thanks for taking the time to fill out this bug report! 🙏
Please provide as much detail as possible to help us address the issue.
- type: textarea
id: description
attributes:
label: 📝 Description
description: A clear and concise description of the bug
placeholder: When using the function X, I expected Y but got Z instead...
validations:
required: true
- type: textarea
id: steps
attributes:
label: 🔄 Steps to Reproduce
description: Provide a minimal code example that reproduces the error
value: |

Use the following suggested headers to structure your bug report.
Feel free to modify or add sections as needed to best communicate the issue.

## 📝 Description
[Provide a clear and concise description of the bug]

## 🔄 Steps to Reproduce
[Provide a minimal code example that reproduces the error]
adamamer20 marked this conversation as resolved.
Show resolved Hide resolved
```python
# Your code here (DO NOT REMOVE the ```python and ``` lines)
# Your code here
```
validations:
required: true
- type: textarea
id: expected
attributes:
label: 🎯 Expected Behavior
description: What you expected to happen
placeholder: I expected the function to return...
validations:
required: true
- type: textarea
id: actual
attributes:
label: 🚨 Actual Behavior
description: What actually happened
placeholder: Instead, the function returned... / I got the following error...
validations:
required: true
- type: textarea
id: environment
attributes:
label: 🖥️ Environment Information
description: |
Please provide details about your environment.
Include Python version, OS, and relevant package versions.
value: |

## 🎯 Expected Behavior
[What did you expect to happen?]

## 🚨 Actual Behavior
[What actually happened? Include any error messages or unexpected output]

## 🖥️ Environment Information
Python version:
Operating System:

Relevant packages (output of `pip list` or the specific packages related to this issue):
```
# Paste your pip list output or relevant package versions here
```
validations:
required: true
- 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: textarea
id: additional
attributes:
label: ➕ Additional Context
description: Add any other context about the problem here
placeholder: Any other relevant information...

## 📊 Relevant log output
```
# Paste any relevant log output here
```

## ➕ Additional Context
[Add any other context about the problem here]
57 changes: 18 additions & 39 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,42 +9,21 @@ body:
value: |
Thanks for taking the time to fill out this feature request! 🙏
We appreciate your ideas to improve our project.
- type: textarea
id: problem
attributes:
label: 🤔 Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: solution
attributes:
label: 💡 Describe the solution you'd like
description: A clear and concise description of what you want to happen.
placeholder: In this situation, I would like [...]
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: 🔄 Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered.
placeholder: I have also thought about [...]
- type: dropdown
id: priority
attributes:
label: 🚀 Priority
description: How important is this feature to you?
options:
- 🟢 Low (Nice to have)
- 🟡 Medium (Important)
- 🔴 High (Critical)
validations:
required: true
- type: textarea
id: additional
attributes:
label: ➕ Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Any other relevant information...

Please use the following suggested headers to structure your feature request.
Feel free to modify or add sections as needed to best communicate your idea.

## 🤔 Problem Description
[Is your feature request related to a problem? Please provide a clear and concise description of what the problem is.]

## 💡 Proposed Solution
[Describe the solution you'd like. What do you want to happen?]

## 🔄 Alternatives Considered
[Have you considered any alternative solutions or features? If so, please describe them.]

## 🚀 Priority
adamamer20 marked this conversation as resolved.
Show resolved Hide resolved
[How important is this feature to you? Low/Medium/High]

## ➕ Additional Context
[Add any other context, screenshots, or examples about the feature request here.]