Skip to content

Commit f517b33

Browse files
committed
docs: update issue template
1 parent 4490ce4 commit f517b33

File tree

4 files changed

+55
-28
lines changed

4 files changed

+55
-28
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,20 @@ name: Bug Report
33
about: Create a report to help us improve
44
---
55

6-
We sincerely recommend that you first complete the following checklist:
6+
**NOTE:** Before you start, the following should be completed.
77

8-
- Read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
9-
- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists
10-
- Found the bug on the latest code of the `master` branch.
8+
- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
9+
- Make sure no [similar issue(including closed ones)][issues] exists.
10+
- Make sure the bug is found in the latest code of the `master` branch.
11+
12+
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
13+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
1114

1215
## Describe the bug
1316

1417
<!-- A clear and concise description of what the bug is. -->
1518

16-
### To Reproduce
19+
## To Reproduce
1720

1821
Steps to reproduce the behavior:
1922
<!--
@@ -23,15 +26,15 @@ Steps to reproduce the behavior:
2326
4. See error
2427
-->
2528

26-
### Expected behavior
29+
## Expected behavior
2730

2831
<!-- A clear and concise description of what you expected to happen. -->
2932

30-
### Screenshots
33+
## Logs/Screenshots
3134

32-
<!-- If applicable, add screenshots to help explain your problem. -->
35+
<!-- If applicable, add logs/screenshots to help explain your problem. -->
3336

34-
### Environment
37+
## Environment
3538

3639
| Command | Version |
3740
|-----------------------------------|---------|
@@ -41,21 +44,25 @@ Steps to reproduce the behavior:
4144
| `bundle exec jekyll -v` | |
4245
| `bundle info jekyll-theme-chirpy` | |
4346

47+
<!-- If necessary, uncomment and fill in the following list:
48+
4449
### Desktop
4550
46-
<!-- If necessary, uncomment and fill in the following list:
4751
- OS: [e.g. macOS 10.15.6]
4852
- Browser: [e.g. Chrome 85.0.4183.83 (64-bit)]
53+
4954
-->
5055

56+
<!-- If necessary, uncomment and fill in the following list:
57+
5158
### Smartphone
5259
53-
<!-- If necessary, uncomment and fill in the following list:
5460
- Device: [e.g. iPhone 6]
5561
- OS: [e.g. iOS 13.6.1]
5662
- Browser: [e.g. Chrome 22]
63+
5764
-->
5865

59-
### Additional context
66+
## Additional context
6067

6168
<!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

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

7-
We sincerely recommend that you first complete the following checklist:
7+
**NOTE:** Before you start, the following should be completed.
88

9-
- Read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
10-
- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists
11-
- This PR is built on top of the latest code in the `master` branch.
9+
- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
10+
- Make sure no [similar issue(including closed ones)][issues] exists.
11+
- Make sure the request is based on the latest code in the `master` branch.
12+
13+
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
14+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
1215

1316
## Is your feature request related to a problem? Please describe
1417

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
---
22
name: Help Wanted
3-
about: Need help
3+
about: Need help that is not covered in the tutorial
44
labels: 'help wanted'
55
---
66

7-
We sincerely recommend that you first complete the following checklist:
7+
**NOTE:** Before you start, the following should be completed.
88

9-
- Read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design.
10-
- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists
11-
- Try to find the answer on [Jekyll Forum](https://talk.jekyllrb.com/) and [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll).
12-
- The ask is based on the latest code of the `master` branch.
9+
- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
10+
- Make sure no [similar issue(including closed ones)][issues] exists.
11+
- Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow].
12+
13+
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
14+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
15+
[forum]: https://talk.jekyllrb.com/
16+
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
1317

1418
## Description
1519

1620
<!-- Please describe your need in detail. -->
1721

18-
## What you have tried
22+
## Operations you have already tried
23+
24+
<!-- Describe the effort you went through. -->
1925

20-
<!--
21-
Describe the steps you went through, such as the configuration process.
26+
## Logs/Screenshots
2227

23-
If needed, please attach output logs, screenshots, etc. to describe your issue.
24-
-->
28+
<!-- If applicable, add logs/screenshots to help explain your problem. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
---
22
name: Question
3-
about: Ask whatever you want
3+
about: Issues that differ from other templates
44
labels: question
55
---
66

7+
**NOTE:** Before you start, the following should be completed.
8+
9+
- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
10+
- Make sure no [similar issue(including closed ones)][issues] exists.
11+
- Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow].
12+
13+
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
14+
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
15+
[forum]: https://talk.jekyllrb.com/
16+
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
17+
18+
## Description
19+
720
<!-- Please describe your question in detail. -->

0 commit comments

Comments
 (0)