Skip to content

Commit 2295397

Browse files
authored
Update issue templates (#606)
* Update issue templates * Mark reproduce section as required
1 parent 0e8bacb commit 2295397

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name: 🐞 Bug report
2-
description: Create a bug report to help us improve Alpaca
2+
description: Create a bug report to help us improve the SDK
33
title: "[Bug]: "
4-
labels: [kind/bug, ]
5-
assignees:
6-
-
4+
labels: [kind/bug]
5+
assignees:
6+
-
77
body:
88
- type: markdown
99
attributes:
@@ -25,6 +25,7 @@ body:
2525
```...```
2626
validations:
2727
required: true
28+
2829
- type: textarea
2930
attributes:
3031
label: Expected Behavior
@@ -33,6 +34,17 @@ body:
3334
validations:
3435
required: false
3536

37+
- type: textarea
38+
attributes:
39+
label: SDK Version I encountered this issue in
40+
description: |
41+
What versions of the SDK have you tried in which the issue is present.
42+
Before opening an issue please make sure you try the latest version of the SDK in case a fix has already been made.
43+
placeholder: |
44+
alpaca-trade-api version: 2.x.x
45+
validations:
46+
required: true
47+
3648
- type: textarea
3749
attributes:
3850
label: Steps To Reproduce
@@ -44,7 +56,15 @@ body:
4456
4. See error...
4557
render: markdown
4658
validations:
47-
required: false
59+
required: true
60+
61+
- type: checkboxes
62+
attributes:
63+
label: Filled out the Steps to Reproduce section?
64+
description: Please verify you have filled out the above section in regards to attaching steps or code that can reproduce your issue so that Alpaca developers can investigate. Not filling out the section will have your issue flagged as invalid and might not be investigated.
65+
options:
66+
- label: I have entered valid steps to reproduce my issue or have attached a minimally reproducible case in code that shows my issue happening; and understand that without this my issue will be flagged as invalid and closed after 30 days.
67+
required: true
4868

4969
- type: textarea
5070
attributes:

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: 🚀 Feature request
2-
description: As a user,
2+
description: As a user, I would like to see this new feature implemented into the SDK
33
labels: [kind/feature]
44
assignees:
5-
Enter Assign Here
5+
-
66
body:
77
- type: markdown
88
attributes:
@@ -43,4 +43,4 @@ body:
4343
validations:
4444
required: false
4545

46-
46+

0 commit comments

Comments
 (0)