docs: update issue template

This commit is contained in:
Cotes Chung 2023-02-16 23:35:17 +08:00
parent 4490ce4107
commit f517b33960
No known key found for this signature in database
GPG key ID: 0D9E54843167A808
4 changed files with 55 additions and 28 deletions

View file

@ -3,17 +3,20 @@ name: Bug Report
about: Create a report to help us improve about: Create a report to help us improve
--- ---
We sincerely recommend that you first complete the following checklist: **NOTE:** Before you start, the following should be completed.
- Read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design. - Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists - Make sure no [similar issue(including closed ones)][issues] exists.
- Found the bug on the latest code of the `master` branch. - Make sure the bug is found in the latest code of the `master` branch.
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
## Describe the bug ## Describe the bug
<!-- A clear and concise description of what the bug is. --> <!-- A clear and concise description of what the bug is. -->
### To Reproduce ## To Reproduce
Steps to reproduce the behavior: Steps to reproduce the behavior:
<!-- <!--
@ -23,15 +26,15 @@ Steps to reproduce the behavior:
4. See error 4. See error
--> -->
### Expected behavior ## Expected behavior
<!-- A clear and concise description of what you expected to happen. --> <!-- A clear and concise description of what you expected to happen. -->
### Screenshots ## Logs/Screenshots
<!-- If applicable, add screenshots to help explain your problem. --> <!-- If applicable, add logs/screenshots to help explain your problem. -->
### Environment ## Environment
| Command | Version | | Command | Version |
|-----------------------------------|---------| |-----------------------------------|---------|
@ -41,21 +44,25 @@ Steps to reproduce the behavior:
| `bundle exec jekyll -v` | | | `bundle exec jekyll -v` | |
| `bundle info jekyll-theme-chirpy` | | | `bundle info jekyll-theme-chirpy` | |
<!-- If necessary, uncomment and fill in the following list:
### Desktop ### Desktop
<!-- If necessary, uncomment and fill in the following list:
- OS: [e.g. macOS 10.15.6] - OS: [e.g. macOS 10.15.6]
- Browser: [e.g. Chrome 85.0.4183.83 (64-bit)] - Browser: [e.g. Chrome 85.0.4183.83 (64-bit)]
--> -->
<!-- If necessary, uncomment and fill in the following list:
### Smartphone ### Smartphone
<!-- If necessary, uncomment and fill in the following list:
- Device: [e.g. iPhone 6] - Device: [e.g. iPhone 6]
- OS: [e.g. iOS 13.6.1] - OS: [e.g. iOS 13.6.1]
- Browser: [e.g. Chrome 22] - Browser: [e.g. Chrome 22]
--> -->
### Additional context ## Additional context
<!-- Add any other context about the problem here. --> <!-- Add any other context about the problem here. -->

View file

@ -4,11 +4,14 @@ about: Suggest an idea for this project
labels: enhancement labels: enhancement
--- ---
We sincerely recommend that you first complete the following checklist: **NOTE:** Before you start, the following should be completed.
- Read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design. - Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists - Make sure no [similar issue(including closed ones)][issues] exists.
- This PR is built on top of the latest code in the `master` branch. - Make sure the request is based on the latest code in the `master` branch.
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
## Is your feature request related to a problem? Please describe ## Is your feature request related to a problem? Please describe

View file

@ -1,24 +1,28 @@
--- ---
name: Help Wanted name: Help Wanted
about: Need help about: Need help that is not covered in the tutorial
labels: 'help wanted' labels: 'help wanted'
--- ---
We sincerely recommend that you first complete the following checklist: **NOTE:** Before you start, the following should be completed.
- Read the [tutorials](https://cotes2020.github.io/chirpy-demo/categories/tutorial/) and know the correct effect of the functional design. - Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists - Make sure no [similar issue(including closed ones)][issues] exists.
- Try to find the answer on [Jekyll Forum](https://talk.jekyllrb.com/) and [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll). - Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow].
- The ask is based on the latest code of the `master` branch.
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
[forum]: https://talk.jekyllrb.com/
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
## Description ## Description
<!-- Please describe your need in detail. --> <!-- Please describe your need in detail. -->
## What you have tried ## Operations you have already tried
<!-- <!-- Describe the effort you went through. -->
Describe the steps you went through, such as the configuration process.
If needed, please attach output logs, screenshots, etc. to describe your issue. ## Logs/Screenshots
-->
<!-- If applicable, add logs/screenshots to help explain your problem. -->

View file

@ -1,7 +1,20 @@
--- ---
name: Question name: Question
about: Ask whatever you want about: Issues that differ from other templates
labels: question labels: question
--- ---
**NOTE:** Before you start, the following should be completed.
- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design.
- Make sure no [similar issue(including closed ones)][issues] exists.
- Try to find the answer on [Jekyll Forum][forum] and [StackOverflow][stack_overflow].
[tutorial]: https://cotes2020.github.io/chirpy-demo/categories/tutorial/
[issues]: https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue
[forum]: https://talk.jekyllrb.com/
[stack_overflow]: https://stackoverflow.com/questions/tagged/jekyll
## Description
<!-- Please describe your question in detail. --> <!-- Please describe your question in detail. -->