Skip to content

Commit 3fa115c

Browse files
Merge pull request #124 from Shopify/improve_issue_template
Improve issue template
2 parents 53d10da + 73bcc4d commit 3fa115c

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,37 +6,42 @@ labels: "Type: Bug 🐛"
66

77
# Issue summary
88

9-
<!--
10-
11-
Write a short description of the issue here. Please provide any details or logs that
12-
can help us debug it.
9+
Before opening this issue, I have:
10+
11+
- [ ] Upgraded to the latest version of the package
12+
- `shopify_api` version:
13+
- `shopify_app` version:
14+
- Ruby version:
15+
- Operating system:
16+
- [ ] Set `log_level: :debug` [in my configuration](https://github.com/Shopify/shopify-api-ruby#setup-shopify-context), if applicable
17+
- [ ] Found a reliable way to reproduce the problem that indicates it's a problem with the package
18+
- [ ] Looked for similar issues in this repository
19+
- [ ] Checked that this isn't an issue with a Shopify API
20+
- If it is, please create a post in the [Shopify community forums](https://community.shopify.com/c/partners-and-developers/ct-p/appdev) or report it to [Shopify Partner Support](https://help.shopify.com/en/support/partners/org-select)
1321

14-
To increase logging, change this setting when setting up your ShopifyApi::Context object:
15-
log_level: :debug,
16-
17-
Learn more: https://github.com/Shopify/shopify-api-ruby/blob/main/docs/getting_started.md#setup-shopify-context
22+
<!--
23+
Write a short description of the issue here.
1824
25+
We can only fix issues for which there is a clear reproduction scenario.
26+
The more context you can provide, the easier it becomes for us to investigate and fix the issue.
1927
-->
2028

21-
- shopify_api version:
22-
- shopify_app version:
23-
- Ruby version:
24-
- Operating system:
25-
26-
```
27-
// Paste any relevant logs here
28-
```
29-
3029
## Expected behavior
3130

32-
<!-- What do you think should happen? -->
31+
What do you think should happen?
3332

3433
## Actual behavior
3534

36-
<!-- What actually happens? -->
35+
What actually happens?
3736

3837
## Steps to reproduce the problem
3938

4039
1.
4140
1.
4241
1.
42+
43+
## Debug logs
44+
45+
```
46+
// Paste any relevant logs here
47+
```

0 commit comments

Comments
 (0)