Skip to content

Commit 2eb6a7b

Browse files
Merge pull request #907 from SimJoSt/feat/improve-issue-templates
feat(issue template): improve syntax for better readability and issue reporting
2 parents 28c8dcb + 30fe17e commit 2eb6a7b

File tree

2 files changed

+25
-21
lines changed

2 files changed

+25
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,26 @@ about: Create a bug report to help us improve themekit
44

55
---
66

7-
**Describe the bug**
8-
A clear and concise description of what the bug is.
7+
#### Describe the bug
8+
<!-- A clear and concise description of what the bug is.-->
99

10-
**To Reproduce**
10+
#### To Reproduce
1111
Steps to reproduce the behavior:
12-
1. run command 'theme new --password=mypassword --store=store.myshopify.com --name=theme'
12+
1. Run command `theme new --password=mypassword --store=store.myshopify.com --name=theme`
1313
2.
1414
3.
1515

16-
**Expected behavior**
17-
A clear and concise description of what you expected to happen.
16+
#### Expected behavior
17+
<!-- A clear and concise description of what you expected to happen.-->
1818

19-
**Environment (please complete the following information):**
20-
- OS [e.g. iOS]:
21-
- Themekit version (run theme version to check):
22-
- Editor [e.g. atom, sublime]:
23-
- Ignore:
19+
#### Environment
20+
<!-- Please complete the following information: -->
21+
Information | Value
22+
--- | ---
23+
OS version | E.g. macOS 11.2
24+
Themekit version | Run `theme version` to check
25+
Editor | E.g. atom, sublime
26+
Ignore | e.g. `config.yml`, `.gitignore`
2427

25-
**Additional context**
26-
Add any other context about the problem here.
28+
#### Additional context
29+
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ about: Suggest an new idea for themekit
44

55
---
66

7-
**Is your feature request related to a problem? Please describe.**
8-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
7+
#### Is your feature request related to a problem? Please describe.
8+
<!-- A clear and concise description of what the problem is. -->
9+
E.g. I'm always frustrated when [...]
910

10-
**Describe the solution you'd like**
11-
A clear and concise description of what you want to happen.
11+
#### Describe the solution you'd like
12+
<!-- A clear and concise description of what you want to happen. -->
1213

13-
**Describe alternatives you've considered**
14-
A clear and concise description of any alternative solutions or features you've considered.
14+
#### Describe alternatives you've considered
15+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1516

16-
**Additional context**
17-
Add any other context or screenshots about the feature request here.
17+
#### Additional context
18+
<!-- Add any other context or screenshots about the feature request here. -->

0 commit comments

Comments
 (0)