Skip to content

Commit 866491a

Browse files
authored
chore: Add issue templates (#24)
Signed-off-by: Christian Kadner <[email protected]>
1 parent b5f534a commit 866491a

File tree

4 files changed

+132
-0
lines changed

4 files changed

+132
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ""
5+
labels: "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+
Script that can be used to send a request that reproduced the behavior (preferably using `grpcurl`):
16+
```
17+
grpcurl -plaintext -proto proto/generation.proto -d \
18+
'{
19+
"model_id": "",
20+
"requests": [
21+
{
22+
"text": "<Text that causes the bad behavior>"
23+
}
24+
],
25+
"params":{
26+
}
27+
}' \
28+
localhost:8033 fmaas.GenerationService/Generate
29+
```
30+
31+
**Expected behavior**
32+
33+
<!-- A clear and concise description of what you expected to happen. -->
34+
35+
**Screenshots**
36+
37+
<!-- If applicable, add screenshots to help explain your problem. -->
38+
39+
**Environment (please complete the following information):**
40+
41+
- OS/Architecture [e.g. linux amd64]
42+
- Version [e.g. git commit short-hash 5f67482]
43+
- Model [e.g. bigscience/bloom]
44+
45+
**Additional context**
46+
47+
<!-- Add any other context about the problem here. -->
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
<!-- Complete this request to suggest an idea or improvement to a project. -->
10+
11+
**Is your feature request related to a problem? If so, please describe.**
12+
13+
<!-- Please provide a clear and concise description of what the problem is. Ex. "I am always frustrated when [...]" -->
14+
15+
**Describe your proposed solution**
16+
17+
<!-- Please provide a clear and concise description of the solution you would like to propose. -->
18+
19+
**Describe alternatives you have considered**
20+
21+
<!-- Please provide a clear and concise description of any alternative solutions or features you've considered. -->
22+
23+
**Additional context**
24+
25+
<!-- Add additional context or screenshots pertaining to the feature request here. -->

.github/ISSUE_TEMPLATE/user_story.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: User story
3+
about: Create a user story for this project
4+
title: ""
5+
assignees: ""
6+
---
7+
8+
## Overview
9+
10+
<!--
11+
Describe the goal or feature or two, usually in the form of a user story.
12+
As a [USER], I want to [TASK], so that [REASON]
13+
-->
14+
15+
### Acceptance Criteria
16+
17+
<!-- Ask yourself, are these criteria testable?
18+
19+
- [ ] List of what needs to be true
20+
- [ ] to consider this done
21+
- [ ] done done
22+
-->
23+
24+
### Questions
25+
26+
<!--
27+
- List any questions?
28+
- That you are unsure of the answer?
29+
-->
30+
31+
### Assumptions
32+
33+
<!--
34+
- List any assumptions that
35+
- You are making in terms of time-frame,
36+
- Output, or general context setting
37+
-->
38+
39+
### Reference
40+
41+
<!--
42+
- [Reference](links)
43+
- [To issues](or-any-inspiration)
44+
- [That might be](helpful)
45+
-->

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### Motivation
2+
3+
[Describe why this change is needed]
4+
5+
#### Modifications
6+
7+
[Describe the code changes]
8+
9+
#### Result
10+
11+
[Describe how the changes affects existing behavior and how to test it]
12+
13+
#### Related Issues
14+
15+
[Resolves #123]

0 commit comments

Comments
 (0)