Improve the issue templates

This commit is contained in:
Cotes Chung 2021-10-04 17:53:07 +08:00
parent 80980465d7
commit 80fd684577
4 changed files with 26 additions and 13 deletions

View File

@ -6,12 +6,15 @@ about: Create a report to help us improve
<!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) --> <!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
## Checklist ## Checklist
<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" --> <!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design. - [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
- [ ] There are no similar reports on existing issues (including closed ones). - [ ] There are no similar reports on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
- [ ] I found the bug on the latest code of the `master` branch. - [ ] I found the bug on the latest code of the `master` branch.
## 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
@ -25,12 +28,15 @@ Steps to reproduce the behavior:
--> -->
### 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 ### Screenshots
<!-- If applicable, add screenshots to help explain your problem. --> <!-- If applicable, add screenshots to help explain your problem. -->
### Software ### Software
<!-- Please complete the following information --> <!-- Please complete the following information -->
- Ruby version: <!-- by running: `ruby -v` --> - Ruby version: <!-- by running: `ruby -v` -->
- Gem version: <!-- by running: `gem -v`--> - Gem version: <!-- by running: `gem -v`-->
@ -39,12 +45,14 @@ Steps to reproduce the behavior:
- Theme version: <!-- by running: `gem list | grep jekyll-theme-chirpy` --> - Theme version: <!-- by running: `gem list | grep jekyll-theme-chirpy` -->
### Desktop ### Desktop
<!-- If necessary, uncomment and fill in the following list: <!-- 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)]
--> -->
### Smartphone ### Smartphone
<!-- If necessary, uncomment and fill in the following list: <!-- 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]
@ -52,4 +60,5 @@ Steps to reproduce the behavior:
--> -->
### Additional context ### Additional context
<!-- Add any other context about the problem here. --> <!-- Add any other context about the problem here. -->

View File

@ -7,24 +7,29 @@ labels: enhancement
<!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) --> <!-- NOTE: Please maintain all sections, otherwise the issue will be automatically closed :) -->
## Checklist ## Checklist
<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" --> <!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
- [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md). - [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md).
- [ ] There is no similar request on existing issues (including closed ones). - [ ] There is no similar request on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
- [ ] I have read the [project progress](https://github.com/cotes2020/jekyll-theme-chirpy/projects) and know the current progress of the project. - [ ] I have read the [project progress](https://github.com/cotes2020/jekyll-theme-chirpy/projects) and know the current progress of the project.
- [ ] I was in the `master` branch of the latest code. - [ ] I was in the `master` branch of the latest code.
## Is your feature request related to a problem? Please describe ## Is your feature request related to a problem? Please describe
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
## Describe the solution you'd like ## Describe the solution you'd like
<!-- A clear and concise description of what you want to happen. --> <!-- A clear and concise description of what you want to happen. -->
## Describe alternatives you've considered ## Describe alternatives you've considered
<!-- A clear and concise description of any alternative solutions or features you've considered. --> <!-- A clear and concise description of any alternative solutions or features you've considered. -->
## Additional context ## Additional context
<!-- Add any other context or screenshots about the feature request here. --> <!-- Add any other context or screenshots about the feature request here. -->

View File

@ -1,6 +1,6 @@
--- ---
name: Question name: Question
about: Ask what ever you want about: Ask whatever you want
labels: question labels: question
--- ---
@ -10,10 +10,11 @@ labels: question
<!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" --> <!-- Please complete the following list of tasks, and then check it by changing the "[ ]" to "[x]" -->
- [ ] I have read the [tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design. - [ ] I have read the [newlest tutorials](https://chirpy.cotes.info/categories/tutorial/) and know the correct effect of the functional design.
- [ ] There is no similar question on existing issues (including closed ones). - [ ] There is no similar question on [existing issues](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones).
- [ ] I searched the Internet for related problems, but still couldn't solve them. - [ ] I have tried to find the answer on [Jekyll Forum](https://talk.jekyllrb.com/) and [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll).
- [ ] My question is based on the latest code of the `master` branch. - [ ] My question is based on the latest code of the `master` branch.
## Description ## Description
<!-- Please describe your question in detail. --> <!-- Please describe your question in detail. -->

View File

@ -29,16 +29,14 @@ Please describe the tests that you ran to verify your changes. Provide instructi
- Browser type & version: - Browser type & version:
- Operating system: - Operating system:
- Bundler version: - Ruby version: <!-- by running: `ruby -v` -->
- Ruby version: - Bundler version: <!-- by running: `bundle -v`-->
- Jekyll version: - Jekyll version: <!-- by running: `bundle list | grep " jekyll "` -->
### Checklist ### Checklist
<!-- Select checkboxes by change the "[ ]" to "[x]" --> <!-- Select checkboxes by change the "[ ]" to "[x]" -->
- [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/) - [ ] I have performed a self-review of my code
- [ ] I have performed a self-review of my own code
- [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have commented on my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation - [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings - [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] Any dependent changes have been merged and published in downstream modules