Skip to content

Commit 99c181e

Browse files
authored
feat: add ISSUE_TEMPLATE (#21)
* ISSUE_TEMPLATEを作成したい Fixes #6 * fix: wrong wording for ISSUE_TEMPLATE * fix: use 日本語 instead of Japanese for ISSUE_TEMPLATE * fix: question label for ISSUE_TEMPLATE * fix: correct slack name in ISSUE_TEMPLATE
1 parent 7cb7612 commit 99c181e

File tree

3 files changed

+152
-0
lines changed

3 files changed

+152
-0
lines changed
+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: 🐞 Bug report/バグ報告
2+
description: Create a bug report to help us improve the SDK
3+
title: "[Bug]: "
4+
labels: [ bug ]
5+
assignees:
6+
-
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report! Please fill the form in English/日本語!
12+
- type: checkboxes
13+
attributes:
14+
label: Is there an existing issue for this?
15+
description: Please search to see if an issue already exists for the bug you encountered.
16+
options:
17+
- label: I have searched the existing issues
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Current Behavior
22+
description: A concise description of what you're experiencing.
23+
placeholder: |
24+
When I do <X>, <Y> happens and I see the error message attached below:
25+
```...```
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
attributes:
31+
label: Expected Behavior
32+
description: A concise description of what you expected to happen.
33+
placeholder: When I do <X>, <Z> should happen instead.
34+
validations:
35+
required: false
36+
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+
jquants-api-client version: 0.x.x
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
attributes:
50+
label: Steps To Reproduce
51+
description: Steps to reproduce the behavior.
52+
placeholder: |
53+
1. In this environment...
54+
2. With this config...
55+
3. Run '...'
56+
4. See error...
57+
render: markdown
58+
validations:
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 engineers 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
68+
69+
- type: textarea
70+
attributes:
71+
label: Anything else?
72+
description: |
73+
Links? References? Anything that will give us more context about the issue you are encountering!
74+
validations:
75+
required: false
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 🚀 Feature request/機能追加リクエスト
2+
description: As a user, I would like to see this new feature implemented into the SDK
3+
labels: [ feature ]
4+
assignees:
5+
-
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to request a feature for jquants-api-client-python! Please fill the form in English/日本語!
11+
- type: checkboxes
12+
attributes:
13+
label: Is there an existing issue for this?
14+
description: Please search to see if an issue related to this feature request already exists.
15+
options:
16+
- label: I have searched the existing issues
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Is your feature request related to a problem? Please describe.
21+
description: A concise description of the problem you are facing or the motivetion behind this feature request.
22+
placeholder: |
23+
I faced a problem due to which ...
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Describe the solution you'd like.
29+
description: A concise description of the solution for the issue.
30+
validations:
31+
required: false
32+
- type: textarea
33+
attributes:
34+
label: Describe an alternate solution.
35+
description: Is there any other app issue to solve the problem?
36+
validations:
37+
required: false
38+
- type: textarea
39+
attributes:
40+
label: Anything else? (Additional Context)
41+
description: |
42+
Links? References? Anything that will give us more context about this!
43+
validations:
44+
required: false

.github/ISSUE_TEMPLATE/question.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: ❓ Questions/質問 ❓
2+
description: I have a question about the SDK I can't find an answer to in the documentation or README.
3+
title: "[Question]: "
4+
labels: [ question ]
5+
assignees:
6+
-
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Please fill the form in English/日本語!
12+
- type: checkboxes
13+
attributes:
14+
label: Question form pre-submit checklist.
15+
description: |
16+
Please verify that all these checkboxes are true before opening an issue.
17+
If your issue is determined to violate one of the below questions it will be closed for being invalid.
18+
options:
19+
- label: I have searched the existing issues to ensure there isn't already an issue about this question.
20+
required: true
21+
- label: My question has to do with the Python SDK and isn't a general question about the API. (If it is please open your issue in J-Quants API Community on Slack)
22+
required: true
23+
- label: My question isn't about how to do a specific algorithm or asking for trade advice (answers to these are outside the scope of this repo).
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Question
28+
description: Please describe your question here
29+
placeholder: |
30+
I couldn't find an example or documentation on X. How do I do X ?
31+
```...```
32+
validations:
33+
required: true

0 commit comments

Comments
 (0)