Skip to content

Commit

Permalink
Adding GH Issue Templates (#97)
Browse files Browse the repository at this point in the history
* adding bug report template

* adding feature request template

* emojify bug report

* emojify the feature request

* adding triage for issue template

* sections -> headers

* remove priority

* linking stackoverflow minimal reproducible example
  • Loading branch information
adamamer20 authored Sep 3, 2024
1 parent 070eb06 commit 9c2fd94
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: πŸ› Bug Report
description: File a bug report for mesa-frames
title: "[Bug]: "
labels: ["triage", "bug"]
assignees: []
body:
- type: markdown
attributes:
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.
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, see https://stackoverflow.com/help/minimal-reproducible-example]
```python
# Your code here
```
## 🎯 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
```
## πŸ“Š Relevant log output
```
# Paste any relevant log output here
```
## βž• Additional Context
[Add any other context about the problem here]
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: ✨ Feature Request
description: Suggest a feature for mesa-frames
title: "[Feature]: "
labels: ["triage", "feature"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request! πŸ™
We appreciate your ideas to improve our project.
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.]
## βž• Additional Context
[Add any other context, screenshots, or examples about the feature request here.]

0 comments on commit 9c2fd94

Please sign in to comment.