From 9a1eab26354ad3ef086aebcd84309e912cef7131 Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Wed, 24 Jun 2020 20:46:24 +0800 Subject: [PATCH] Improved the issue templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 18 ++++++++++-------- .github/ISSUE_TEMPLATE/feature_request.md | 12 +++++++----- .github/ISSUE_TEMPLATE/question.md | 10 ++++++---- 3 files changed, 23 insertions(+), 17 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index a0ef3de..c8d8379 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,17 +4,19 @@ about: Create a report to help us improve labels: bug --- -# Checklist + + +## 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). - [ ] I found the bug on the latest code of `master` branch. -# Describe the bug +## Describe the bug -## To Reproduce +**To Reproduce** Steps to reproduce the behavior: @@ -24,24 +26,24 @@ Steps to reproduce the behavior: 4. See error -## Expected behavior +**Expected behavior** -## Screenshots +**Screenshots** -## Desktop: +**Desktop** - OS: [e.g. iOS] - Browser: [e.g. chrome, safari] - Version: [e.g. 22] -## Smartphone: +**Smartphone** - Device: [e.g. iPhone6] - OS: [e.g. iOS8.1] - Browser: [e.g. stock browser, safari] - Version: [e.g. 22] -## Additional context +**Additional context** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index d2ff7d8..dd4f25b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,7 +4,9 @@ about: Suggest an idea for this project labels: enhancement --- -# Checklist + + +## Checklist - [ ] I have read the [contributing guidelines](https://github.com/cotes2020/jekyll-theme-chirpy/blob/master/.github/CONTRIBUTING.md). - [ ] There are no similar request on existing issues (including closed ones). @@ -12,17 +14,17 @@ labels: enhancement - [ ] 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 -# Describe the solution you'd like +## Describe the solution you'd like -# Describe alternatives you've considered +## Describe alternatives you've considered -# Additional context +## Additional context diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 273e6d2..17eaa8c 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -4,7 +4,9 @@ about: Ask what ever you want labels: question --- -# Checklist + + +## 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 question on existing issues (including closed ones). @@ -12,13 +14,13 @@ labels: question - [ ] My question is based on the latest code of `master` branch. -# I don't understand what the ReadMe/Wiki says +## I don't understand what the ReadMe/Wiki says -# I have other questions +## I have other questions \ No newline at end of file