From 80fd6845775cfb95dfe09036ae77100b0dfa4fa1 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Mon, 4 Oct 2021 17:53:07 +0800 Subject: [PATCH] Improve the issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 11 ++++++++++- .github/ISSUE_TEMPLATE/feature_request.md | 7 ++++++- .github/ISSUE_TEMPLATE/question.md | 9 +++++---- .github/PULL_REQUEST_TEMPLATE.md | 12 +++++------- 4 files changed, 26 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8dd46c7..d86d872 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,12 +6,15 @@ about: Create a report to help us improve ## Checklist + + - [ ] 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. ## Describe the bug + ### To Reproduce @@ -25,12 +28,15 @@ Steps to reproduce the behavior: --> ### Expected behavior + ### Screenshots + ### Software + - Ruby version: - Gem version: @@ -39,12 +45,14 @@ Steps to reproduce the behavior: - Theme version: ### Desktop + ### Smartphone + ### Additional context + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 23975f0..7d866cf 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,24 +7,29 @@ labels: enhancement ## Checklist + - [ ] 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 was in the `master` branch of the latest code. ## Is your feature request related to a problem? Please describe + ## Describe the solution you'd like + ## Describe alternatives you've considered + ## Additional context + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index b271ea2..80f94fd 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,6 +1,6 @@ --- name: Question -about: Ask what ever you want +about: Ask whatever you want labels: question --- @@ -10,10 +10,11 @@ labels: question -- [ ] I have read the [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). -- [ ] I searched the Internet for related problems, but still couldn't solve them. +- [ ] 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](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue) (including closed ones). +- [ ] 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. ## Description + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5fede19..0906ce6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,16 +29,14 @@ Please describe the tests that you ran to verify your changes. Provide instructi - Browser type & version: - Operating system: -- Bundler version: -- Ruby version: -- Jekyll version: +- Ruby version: +- Bundler version: +- Jekyll version: ### Checklist + -- [ ] My code follows the [Google style guidelines](https://google.github.io/styleguide/) -- [ ] I have performed a self-review of my own code +- [ ] I have performed a self-review of my code - [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] 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