Skip to content

Commit c8d6f16

Browse files
authored
Merge pull request #1286 from Shopify/improve_issue_template
Improve issue template
2 parents 5025674 + e8f6d17 commit c8d6f16

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,35 +6,41 @@ 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+
- Ruby version:
14+
- Operating system:
15+
- [ ] Set `log_level: :debug` [in my configuration](https://github.com/Shopify/shopify-api-ruby#setup-shopify-context), if applicable
16+
- [ ] Found a reliable way to reproduce the problem that indicates it's a problem with the package
17+
- [ ] Looked for similar issues in this repository
18+
- [ ] Checked that this isn't an issue with a Shopify API
19+
- 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)
1320

14-
Increase the logs as described in the README by setting log_level to :debug, and paste the relevant portion here.
15-
16-
Learn more: https://github.com/Shopify/shopify-api-ruby#setup-shopify-context
21+
<!--
22+
Write a short description of the issue here.
1723
24+
We can only fix issues for which there is a clear reproduction scenario.
25+
The more context you can provide, the easier it becomes for us to investigate and fix the issue.
1826
-->
1927

20-
- `shopify_api` version:
21-
- Ruby version:
22-
- Operating system:
23-
24-
```
25-
// Paste any relevant logs here
26-
```
27-
2828
## Expected behavior
2929

30-
<!-- What do you think should happen? -->
30+
What do you think should happen?
3131

3232
## Actual behavior
3333

34-
<!-- What actually happens? -->
34+
What actually happens?
3535

3636
## Steps to reproduce the problem
3737

3838
1.
3939
1.
4040
1.
41+
42+
## Debug logs
43+
44+
```
45+
// Paste any relevant logs here
46+
```

0 commit comments

Comments
 (0)