Skip to content

Commit 57916ad

Browse files
authored
Update issue templates (#288)
* Update issue templates * add bug emoji * add rocket ship emoji * modifying gh issues templates * consolidating bug report template * adding new feature prioritization comments * whoops
1 parent dfd75c9 commit 57916ad

File tree

3 files changed

+97
-0
lines changed

3 files changed

+97
-0
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Submit a bug report to help us improve LLM Engine. If this doesn't look right, [choose a different type.](https://github.com/scaleapi/llm-engine/issues/new/choose)
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
Thank you for taking the time to file a bug report! Before you do so, please take a look at existing open issues and make sure that your issue is not already documented. If it isn't, please provide us with a clear and concise description of what the bug is.
12+
13+
**LLM Engine Version**
14+
- LLM Engine Version:
15+
16+
**System Version**
17+
- Python Version:
18+
- Operating System:
19+
20+
**Timestamp and Request ID**
21+
_If you ran into an internal error while using `llm-engine`, please provide the following_
22+
- Timestamp:
23+
- Request ID:
24+
25+
**Minimal Reproducible Example**
26+
Steps to reproduce the behavior:
27+
1. Install LLM Engine '....'
28+
2. Make API call '....'
29+
3. See error
30+
31+
Please provide a code snippet that documents how your bug can be reproduced.
32+
```
33+
import llmengine
34+
...
35+
```
36+
37+
**Expected behavior**
38+
A clear and concise description of what you expected to happen.
39+
40+
**Additional context**
41+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: If your issue doesn't fall into a bug template or feature request, please provide some information on it here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: "\U0001F680 Feature request"
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Feature Request
11+
12+
**What is the problem you're currently running into?**
13+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
15+
**Why do you want this feature?**
16+
A clear and concise description of why you want the feature.
17+
18+
**Describe the solution you'd like**
19+
A clear and concise description of what you want to happen.
20+
21+
**Describe alternatives you've considered**
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
24+
**Additional context**
25+
Add any other context or screenshots about the feature request here.
26+
27+
### Prioritization
28+
29+
- **Does this feature block you from using the project?**
30+
- [ ] Yes
31+
- [ ] No
32+
33+
- **How many users will benefit from this feature?**
34+
- [ ] Just me
35+
- [ ] Few people might benefit
36+
- [ ] Many users will love it!
37+
38+
- **Complexity**
39+
- [ ] I believe it's a simple feature to implement
40+
- [ ] It might require some effort to implement
41+
- [ ] It's probably complex, and might take significant effort
42+
43+
---
44+
45+
Thank you for your contribution to `llm-engine`. Please ensure you've given the feature considerable thought before submitting it. Once your feature request is accepted, and you're interested in building it, please mention it so that the maintainers can guide you!
46+

0 commit comments

Comments
 (0)