From b8f6950cfa020cd74c0e6f32d2abc13996c616b2 Mon Sep 17 00:00:00 2001 From: ppoffice Date: Sun, 24 May 2020 11:50:13 -0400 Subject: [PATCH] chore(doc): update issue templates and some links --- .github/ISSUE_TEMPLATE/Bug反馈.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 27 ++++++---------- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++-- .github/ISSUE_TEMPLATE/功能建议.md | 26 +++++++++++++++ README.md | 2 +- include/schema/common/donates.json | 2 +- 6 files changed, 81 insertions(+), 21 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Bug反馈.md create mode 100644 .github/ISSUE_TEMPLATE/功能建议.md diff --git a/.github/ISSUE_TEMPLATE/Bug反馈.md b/.github/ISSUE_TEMPLATE/Bug反馈.md new file mode 100644 index 0000000..d5a49bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug反馈.md @@ -0,0 +1,39 @@ +--- +name: Bug反馈 +about: 请按照模板填写Bug反馈，否则你的Issue可能会被直接关闭。与Icarus使用相关的问题请转至Gitter（https://gitter.im/hexo-theme-icarus/community）。 +title: '' +labels: '' +assignees: '' + +--- + +> 确保你在提交Bug反馈之前仔细阅读了[Hexo文档](https://hexo.io/zh-cn/)，[Icarus用户指南](https://ppoffice.github.io/hexo-theme-icarus/tags/Icarus%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/)，和[GitHub issues](https://github.com/ppoffice/hexo-theme-icarus/issues)来了解你的问题是否已经被他人提出过。 + +**Bug描述** +简洁清晰地描述你遇到的Bug是什么。 + +**系统与环境** +列出你的Hexo和Icarus的版本和配置。 + +- Hexo，操作系统，和Node.js的版本（使用`hexo version`命令来查看） +- 站点配置文件`_config.yml` +- 主题配置文件`themes/icarus/_config.yml` +- 其他额外的配置文件（文章front-matter，`_config.post.yml`，或`_config.page.yml`） +- 浏览器版本（如Firefox 70.0，Chrome Android 80.0） + +**复现方式** +列出复现这个Bug的步骤，如： + +1. 访问‘...’ +2. 点击’...‘ +3. 下拉到‘...’ +4. 出现‘...’的错误 + +**期望行为** +简洁清晰地描述没有这个情况下你期望得到的结果。 + +**截图** +如果可以的话，请附上几张截图来帮助说明你遇到的问题。 + +**额外上下文** +附上与问题有关的其他上下文信息。 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2c3b8a1..a2184b3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,29 +1,33 @@ --- name: Bug report -about: Create a report to help us improve +about: Please follow this template if you are reporting a bug, or your issue may be closed without further notice. And redirect your Icarus customization questions to Gitter (https://gitter.im/hexo-theme-icarus/community). title: '' labels: '' assignees: '' --- +> Make sure you go through the [Hexo docs](https://hexo.io), [Icarus user manual](https://ppoffice.github.io/hexo-theme-icarus/tags/Icarus-User-Guide/), and [GitHub issues](https://github.com/ppoffice/hexo-theme-icarus/issues) to see if the bug you are reporting has been already addressed by others. + **Describe the bug** A clear and concise description of what the bug is. **System and Environment** The version and configuration of Hexo and Icarus. -- Hexo, OS, and node version (use `hexo version` command) +- Hexo, OS, and node version (use `hexo version` command to view these information) - Site configuration file `_config.yml` - Theme configuration file `themes/icarus/_config.yml` - Any additional theme configuration files (post front-matter, `_config.post.yml`, or `_config.page.yml`) +- Browser and version (e.g., Firefox 70.0, Chrome Android 80.0) **To Reproduce** -Steps to reproduce the behavior: +Steps to reproduce the behavior, such as: + 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +2. Click on '...' +3. Scroll down to '...' +4. '...' error appears **Expected behavior** A clear and concise description of what you expected to happen. @@ -31,16 +35,5 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information if applicable):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information if applicable):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index f0291e0..a3dcc5b 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,15 +1,17 @@ --- name: Feature request -about: Suggest an idea for this project +about: Please follow this template if you are requesting a new feature, or your issue may be closed without further notice. And redirect your Icarus customization questions to Gitter (https://gitter.im/hexo-theme-icarus/community). title: '' labels: '' assignees: '' --- +> Make sure you go through the [Hexo docs](https://hexo.io), [Icarus user manual](https://ppoffice.github.io/hexo-theme-icarus/tags/Icarus-User-Guide/), and [GitHub issues](https://github.com/ppoffice/hexo-theme-icarus/issues) to see if the feature you are requesting has been already addressed by others. + **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 (e.g., I'm always frustrated when [...]). **Describe the solution you'd like** diff --git a/.github/ISSUE_TEMPLATE/功能建议.md b/.github/ISSUE_TEMPLATE/功能建议.md new file mode 100644 index 0000000..49bb9ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/功能建议.md @@ -0,0 +1,26 @@ +--- +name: 功能建议 +about: 请按照模板填写功能建议，否则你的Issue可能会被直接关闭。与Icarus使用相关的问题请转至Gitter（https://gitter.im/hexo-theme-icarus/community）。 +title: '' +labels: '' +assignees: '' + +--- + +> 确保你在提交功能建议之前仔细阅读了[Hexo文档](https://hexo.io/zh-cn/)，[Icarus用户指南](https://ppoffice.github.io/hexo-theme-icarus/tags/Icarus%E7%94%A8%E6%88%B7%E6%8C%87%E5%8D%97/)，和[GitHub issues](https://github.com/ppoffice/hexo-theme-icarus/issues)来了解你的建议是否已经被他人提出过。 + +**你的功能建议与某个使用问题相关么？请详述。** + +简洁清晰地描述你遇到的问题是什么（如：我在使用...的时候遇到了...）。 + +**描述你想要的解决方案** + +简洁清晰地描述你想要的解决方案可以达到的效果。 + +**描述你考虑过的替代办法** + +简洁清晰地描述你考虑过的替代解决方案或是新功能。 + +**额外上下文** + +附上与功能请求有关的其他上下文信息或者截图。 diff --git a/README.md b/README.md index 1cb6cd1..a3a2c0d 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ blog feature-rich and powerful. Search Share Widgets - Other Plugins + Other Plugins Changyan diff --git a/include/schema/common/donates.json b/include/schema/common/donates.json index ff5ca05..6ff46f1 100644 --- a/include/schema/common/donates.json +++ b/include/schema/common/donates.json @@ -1,7 +1,7 @@ { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "/common/donates.json", - "description": "Donate plugin configurations\nhttps://blog.zhangruipeng.me/hexo-theme-icarus/categories/Plugins/Donation/", + "description": "Donate plugin configurations\nhttps://ppoffice.github.io/hexo-theme-icarus/categories/Plugins/Donation/", "type": "array", "items": { "type": "object",