From f517b339606a1111d8ca297a5545a32156aa1530 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Thu, 16 Feb 2023 23:35:17 +0800 Subject: [PATCH] docs: update issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ++++++++++++++--------- .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++--- .github/ISSUE_TEMPLATE/help_wanted.md | 26 +++++++++++-------- .github/ISSUE_TEMPLATE/question.md | 15 ++++++++++- 4 files changed, 55 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e5bd773..c69cfb3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,17 +3,20 @@ name: Bug Report 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. -- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists -- Found the bug on the latest code of the `master` branch. +- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design. +- Make sure no [similar issue(including closed ones)][issues] exists. +- 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 -### To Reproduce +## To Reproduce Steps to reproduce the behavior: -### Expected behavior +## Expected behavior -### Screenshots +## Logs/Screenshots - + -### Environment +## Environment | Command | Version | |-----------------------------------|---------| @@ -41,21 +44,25 @@ Steps to reproduce the behavior: | `bundle exec jekyll -v` | | | `bundle info jekyll-theme-chirpy` | | + + -### Additional context +## Additional context diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index dc52b35..0b8cb58 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,11 +4,14 @@ about: Suggest an idea for this project 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. -- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists -- This PR is built on top of the latest code in the `master` branch. +- Read [tutorial][tutorial] to understand the usage and the correct effect of functional design. +- Make sure no [similar issue(including closed ones)][issues] exists. +- 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 diff --git a/.github/ISSUE_TEMPLATE/help_wanted.md b/.github/ISSUE_TEMPLATE/help_wanted.md index debe1f5..180240e 100644 --- a/.github/ISSUE_TEMPLATE/help_wanted.md +++ b/.github/ISSUE_TEMPLATE/help_wanted.md @@ -1,24 +1,28 @@ --- name: Help Wanted -about: Need help +about: Need help that is not covered in the tutorial 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. -- No similar [issue](https://github.com/cotes2020/jekyll-theme-chirpy/issues?q=is%3Aissue)(including closed ones) exists -- Try to find the answer on [Jekyll Forum](https://talk.jekyllrb.com/) and [StackOverflow](https://stackoverflow.com/questions/tagged/jekyll). -- The ask is based on the latest code of the `master` branch. +- 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 -## What you have tried +## Operations you have already tried - - If needed, please attach output logs, screenshots, etc. to describe your issue. ---> +## Logs/Screenshots + + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 42f5747..fb6c1d7 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,7 +1,20 @@ --- name: Question -about: Ask whatever you want +about: Issues that differ from other templates 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 +