Skip to content

Commit 9005fa5

Browse files
committed
chore(templates): update bug report template for SDK issues
1 parent f2adb2c commit 9005fa5

File tree

1 file changed

+34
-19
lines changed

1 file changed

+34
-19
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

Lines changed: 34 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,45 @@ body:
66
- type: textarea
77
attributes:
88
label: Bug Description
9-
description: A clear and concise description of the problem or unexpected behavior (attach screenshots/gifs if appropriate).
10-
placeholder: Clicking on the "Save" button doesn’t save the form data.
11-
render: markdown
9+
description: Provide a clear and concise description of the issue or unexpected behavior related to the Strapi SDK client.
10+
placeholder: Using the SDK client to fetch data from the "articles" collection does not return the expected results.
1211
validations:
1312
required: true
1413

1514
- type: textarea
1615
attributes:
1716
label: Steps to Reproduce
18-
description: Provide a step-by-step description of how to reproduce the issue. Include code snippets or links to repositories when applicable.
17+
description: Provide a detailed, step-by-step guide on how to reproduce the issue. Include code snippets or links to repositories if applicable.
1918
placeholder: |
2019
Example:
21-
1. Create an Article collection type in your Strapi app
22-
2. Export the API schema
23-
3. Make the following query: `...`
24-
4. See the error in the console
25-
render: markdown
20+
1. Initialize a new Strapi project with an "article" collection type defined as "...".
21+
2. Configure the SDK client with your Strapi API URL and authentication token.
22+
3. Perform a query to fetch entries from a collection: `sdk.collection('articles').find()`.
23+
4. Observe the unexpected behavior or error in the response/output.
2624
validations:
2725
required: true
2826

2927
- type: textarea
3028
attributes:
3129
label: Expected Behavior
32-
description: Describe what you expected to happen instead of the bug. Be as specific as possible.
33-
render: markdown
30+
description: Provide a detailed explanation of what you expected to happen instead of the observed issue. Be as specific as possible.
3431
validations:
3532
required: true
3633

3734
- type: input
35+
id: version
3836
attributes:
3937
label: Version
40-
description: The SDK version used
38+
description: The version of the SDK that was used.
4139
placeholder: 1.0.0
4240
validations:
4341
required: true
4442

4543
- type: dropdown
44+
id: os
4645
attributes:
4746
label: Operating System
48-
description: Select the operating system you are experiencing the issue on.
47+
description: Select the operating system where you are experiencing the issue.
4948
multiple: false
5049
options:
5150
- MacOS
@@ -56,26 +55,42 @@ body:
5655
required: true
5756

5857
- type: dropdown
58+
id: runtime
5959
attributes:
6060
label: Runtime Environment
61-
description: Select the environment where this issue occurs.
62-
multiple: false
61+
description: Select all runtime environments where the issue has occurred.
62+
multiple: true
6363
options:
6464
- Browser
6565
- Node.js
66-
- Other (bun, deno, ...)
66+
- Bun
67+
- Deno
68+
- Other
6769
validations:
6870
required: true
6971

7072
- type: textarea
73+
id: logs
7174
attributes:
7275
label: Logs
73-
description: If applicable, the logs you got from using the SDK
76+
description: If available, please provide the logs generated while using the SDK.
7477
render: shell
7578

79+
- type: textarea
80+
id: screenshots
81+
attributes:
82+
label: Media
83+
description: If available, please upload screenshots or videos to illustrate the issue.
84+
7685
- type: checkboxes
86+
id: checklist
7787
attributes:
7888
label: Confirmation Checklist
7989
options:
80-
- label: I have searched for duplicates and couldn’t find a similar issue.
81-
- label: I have provided all necessary details to reproduce the issue.
90+
- label: I have checked the existing [issues](https://github.com/strapi/sdk-js/issues)
91+
required: true
92+
93+
- label: I agree to follow this project's [Code of Conduct](https://github.com/strapi/sdk-js/blob/main/CODE_OF_CONDUCT.md)
94+
required: true
95+
96+
- label: I would like to work on this issue

0 commit comments

Comments
 (0)