Skip to content

Commit 7353114

Browse files
committed
Improved the issue templates.
1 parent 9531753 commit 7353114

3 files changed

Lines changed: 23 additions & 17 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,19 @@ about: Create a report to help us improve
44
labels: bug
55
---
66

7-
# Checklist
7+
<!-- Note: Please follow the template to open a new issue, otherwise your question will probably be ignored. -->
8+
9+
## Checklist
810
<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
911
- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
1012
- [ ] There are no similar reports on existing issues (including closed ones).
1113
- [ ] I found the bug on the latest code of `master` branch.
1214

1315

14-
# Describe the bug
16+
## Describe the bug
1517
<!-- A clear and concise description of what the bug is. -->
1618

17-
## To Reproduce
19+
**To Reproduce**
1820

1921
Steps to reproduce the behavior:
2022

@@ -24,24 +26,24 @@ Steps to reproduce the behavior:
2426
4. See error
2527

2628

27-
## Expected behavior
29+
**Expected behavior**
2830
<!-- A clear and concise description of what you expected to happen. -->
2931

30-
## Screenshots
32+
**Screenshots**
3133
<!-- If applicable, add screenshots to help explain your problem. -->
3234

33-
## Desktop:
35+
**Desktop**
3436
<!-- Please complete the following information -->
3537
- OS: [e.g. iOS]
3638
- Browser: [e.g. chrome, safari]
3739
- Version: [e.g. 22]
3840

39-
## Smartphone:
41+
**Smartphone**
4042
<!-- please complete the following information -->
4143
- Device: [e.g. iPhone6]
4244
- OS: [e.g. iOS8.1]
4345
- Browser: [e.g. stock browser, safari]
4446
- Version: [e.g. 22]
4547

46-
## Additional context
48+
**Additional context**
4749
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,27 @@ about: Suggest an idea for this project
44
labels: enhancement
55
---
66

7-
# Checklist
7+
<!-- Note: Please follow the template to open a new issue, otherwise your question will probably be ignored. -->
8+
9+
## Checklist
810
<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
911
- [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
1012
- [ ] There are no similar request on existing issues (including closed ones).
1113
- [ ] I have read the [project progress](https://github.com/cotes2020/jekyll-theme-chirpy/projects) and know the current progress of the project.
1214
- [ ] I was in the `master` branch of the latest code.
1315

1416

15-
# Is your feature request related to a problem? Please describe
17+
## Is your feature request related to a problem? Please describe
1618
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1719

1820

19-
# Describe the solution you'd like
21+
## Describe the solution you'd like
2022
<!-- A clear and concise description of what you want to happen. -->
2123

2224

23-
# Describe alternatives you've considered
25+
## Describe alternatives you've considered
2426
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
2527

2628

27-
# Additional context
29+
## Additional context
2830
<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ about: Ask what ever you want
44
labels: question
55
---
66

7-
# Checklist
7+
<!-- Note: Please follow the template to open a new issue, otherwise your question will probably be ignored. -->
8+
9+
## Checklist
810
<!-- Please complete the following list of tasks, and then check it by change the "[ ]" to "[x]" -->
911
- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
1012
- [ ] There are no similar question on existing issues (including closed ones).
1113
- [ ] I searched the Internet for related problems, but still couldn't solve it.
1214
- [ ] My question is based on the latest code of `master` branch.
1315

1416

15-
# I don't understand what the ReadMe/Wiki says
17+
## I don't understand what the ReadMe/Wiki says
1618
<!--
1719
Point out the parts that are hard for you to understand.
1820
-->
1921

2022

21-
# I have other questions
23+
## I have other questions
2224
<!--
23-
Please describe your strange question.
25+
Please describe your question.
2426
-->

0 commit comments

Comments
 (0)