Skip to content

Commit 43fb3ff

Browse files
authored
[CI/CD] [FEAT] Add Github Issue Template (#9)
Add template for * feature * bug * documentation ----------------------- Co-authored-by: tjtanaa <tunjian.tan@embeddedllm.com>
1 parent bafafeb commit 43fb3ff

File tree

4 files changed

+81
-0
lines changed

4 files changed

+81
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us reproduce and fix the bug
4+
title: "[BUG]"
5+
labels: "type: bug"
6+
assignees: ""
7+
---
8+
9+
### Describe the bug
10+
11+
A clear and concise description of what the bug is.
12+
13+
### To Reproduce
14+
15+
Provide the steps to reproduce the behavior.
16+
17+
If relevant, add a **minimal example** so that we can reproduce the error by running the code. We are going to copy-paste your code and we expect to get the same result as you did, so avoid any external data, and include the relevant imports. Please take time to **trim down any irrelevant code** to help us debug efficiently.
18+
19+
### Expected behavior
20+
21+
A clear and concise description of what you expected to happen.
22+
23+
### Screenshots
24+
25+
If applicable, add screenshots to help explain your problem.
26+
27+
### Desktop (please complete the following information):
28+
29+
- OS: [e.g. iOS]
30+
- Browser [e.g. chrome, safari]
31+
- Version [e.g. 22]
32+
33+
### Smartphone (please complete the following information):
34+
35+
- Device: [e.g. iPhone6]
36+
- OS: [e.g. iOS8.1]
37+
- Browser [e.g. stock browser, safari]
38+
- Version [e.g. 22]
39+
40+
### Additional context
41+
42+
Add any other context about the problem here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: 🚀 Feature request
3+
about: Submit a proposal/request for a new JamAIBase feature
4+
title: "[FEAT]"
5+
labels: "type: enhancement / feature"
6+
assignees: ""
7+
---
8+
9+
### Is your feature request related to a problem? Please describe.
10+
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
### Describe the solution you'd like
14+
15+
A clear and concise description of what you want to happen.
16+
17+
### Describe alternatives you've considered
18+
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
### Additional context
22+
23+
Add any other context or screenshots about the feature request here.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: 📚 Documentation
3+
about: Tell us how we could improve the documentation
4+
title: "[DOC]"
5+
labels: "type: documentation"
6+
assignees: ""
7+
---
8+
9+
Tell us how we could improve the documentation.
10+
11+
Thanks for contributing 🎉!

.github/ISSUE_TEMPLATE/config.yaml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💡 Questions, ideas, discussions
4+
about: Ask a question or ask about a problem in GitHub Discussions.
5+
url: https://github.com/EmbeddedLLM/embeddedllm/discussions

0 commit comments

Comments
 (0)