Skip to content

Commit 9c2fd94

Browse files
authored
Adding GH Issue Templates (#97)
* 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
1 parent 070eb06 commit 9c2fd94

File tree

2 files changed

+72
-0
lines changed

2 files changed

+72
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: 🐛 Bug Report
2+
description: File a bug report for mesa-frames
3+
title: "[Bug]: "
4+
labels: ["triage", "bug"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report! 🙏
11+
Please provide as much detail as possible to help us address the issue.
12+
13+
Use the following suggested headers to structure your bug report.
14+
Feel free to modify or add sections as needed to best communicate the issue.
15+
16+
## 📝 Description
17+
[Provide a clear and concise description of the bug]
18+
19+
## 🔄 Steps to Reproduce
20+
[Provide a minimal code example that reproduces the error, see https://stackoverflow.com/help/minimal-reproducible-example]
21+
```python
22+
# Your code here
23+
```
24+
25+
## 🎯 Expected Behavior
26+
[What did you expect to happen?]
27+
28+
## 🚨 Actual Behavior
29+
[What actually happened? Include any error messages or unexpected output]
30+
31+
## 🖥️ Environment Information
32+
Python version:
33+
Operating System:
34+
35+
Relevant packages (output of `pip list` or the specific packages related to this issue):
36+
```
37+
# Paste your pip list output or relevant package versions here
38+
```
39+
40+
## 📊 Relevant log output
41+
```
42+
# Paste any relevant log output here
43+
```
44+
45+
## ➕ Additional Context
46+
[Add any other context about the problem here]
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: ✨ Feature Request
2+
description: Suggest a feature for mesa-frames
3+
title: "[Feature]: "
4+
labels: ["triage", "feature"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this feature request! 🙏
11+
We appreciate your ideas to improve our project.
12+
13+
Please use the following suggested headers to structure your feature request.
14+
Feel free to modify or add sections as needed to best communicate your idea.
15+
16+
## 🤔 Problem Description
17+
[Is your feature request related to a problem? Please provide a clear and concise description of what the problem is.]
18+
19+
## 💡 Proposed Solution
20+
[Describe the solution you'd like. What do you want to happen?]
21+
22+
## 🔄 Alternatives Considered
23+
[Have you considered any alternative solutions or features? If so, please describe them.]
24+
25+
## ➕ Additional Context
26+
[Add any other context, screenshots, or examples about the feature request here.]

0 commit comments

Comments
 (0)