Skip to content

Commit

Permalink
docs: enhance issue templates for better user experience
Browse files Browse the repository at this point in the history
• Update bug report templates with clearer instructions and fields
• Improve feature request templates with more detailed prompts
• Add priority selection to all templates for better issue triage
• Include markdown sections for improved readability
• Standardize template structure across Chinese and English versions
  • Loading branch information
EvanNotFound committed Dec 1, 2024
1 parent 7ef9cf2 commit 114ec21
Show file tree
Hide file tree
Showing 4 changed files with 233 additions and 100 deletions.
130 changes: 83 additions & 47 deletions .github/ISSUE_TEMPLATE/bug-chinese.yml
Original file line number Diff line number Diff line change
@@ -1,75 +1,111 @@
name: Bug 提交 [中文版本]
description: 帮助修复 Redefine 主题的 Bug
description: 提交 Redefine 主题的 Bug 报告
title: "[BUG] "
labels: ["bug"]
assignees: ["EvanNotFound"]
body:
- type: markdown
attributes:
value: |
感谢您提交 Bug 报告!请填写以下信息以帮助我们更好地解决问题。
- type: checkboxes
id: pre-check
attributes:
label: 提交 Issue 前检查清单
description: 请确保确认后,再提交 Issue
label: 提交前检查
options:
- label: "已经尝试执行 `hexo clean`,问题仍然存在"
- label: "[已经更新到主题最新版本](https://redefine-docs.ohevan.com/getting-started#%E6%9B%B4%E6%96%B0)"
- label: "[如果刚更新完主题出现此问题,已经确认同步了主题配置文件](https://redefine-docs.ohevan.com/getting-started#%E8%BF%81%E7%A7%BB%E9%85%8D%E7%BD%AE)"
- label: 我已执行 `hexo clean` 并重新生成,问题仍然存在
required: true
- label: 我已更新到[最新版本](https://redefine-docs.ohevan.com/getting-started#%E6%9B%B4%E6%96%B0)
required: true
- label: 我已确认[同步了主题配置文件](https://redefine-docs.ohevan.com/getting-started#%E8%BF%81%E7%A7%BB%E9%85%8D%E7%BD%AE)
required: true

- type: textarea
id: bug-description
attributes:
label: "Bug 描述"
description: "清晰地描述,请提供 hexo 根目录的网站配置文件 `_config.yml` 和主题配置文件 `_config.redefine.yml` 或 `_config.yml` 中有关的项目。如果有敏感信息请打码(替换一些字符"
label: Bug 描述
description: 请详细描述您遇到的问题,并提供相关配置文件内容(敏感信息请用 *** 替换)
placeholder: |
问题描述:
相关配置: ```yaml
# 在此粘贴配置 ```
validations:
required: true

- type: textarea
id: reproduce-steps
id: reproduce
attributes:
label: "复现方法"
placeholder: "复现该 Bug 的步骤:"
label: 复现步骤
value: |
1.
2.
3.
validations:
required: true

- type: textarea
id: expected-behavior
id: expected
attributes:
label: "预期结果"
placeholder: "该功能本来应该是怎么样的"
label: 预期行为
description: 请描述正常情况下应该是什么样的

- type: textarea
id: screenshots
attributes:
label: "截图"
description: "如果可以,请添加截图以帮助解释您的问题。"
- type: input
id: pc-os
attributes:
label: "电脑操作系统"
placeholder: "例如 macOS, Windows"
- type: input
id: pc-browser
label: 截图
description: 如果可以,请提供截图以帮助说明问题

- type: textarea
id: logs
attributes:
label: "浏览器"
placeholder: "例如 Chrome, Safari"
- type: input
id: pc-version
label: 相关日志输出
description: 请复制并粘贴任何相关的日志输出。这将自动格式化为代码,因此不需要反引号。
render: shell

- type: dropdown
id: browsers
attributes:
label: "版本"
placeholder: "例如 108"
- type: input
id: mobile-device
attributes:
label: "移动端设备"
placeholder: "例如 iPhone 14"
- type: input
id: mobile-os
label: 使用的浏览器
multiple: true
options:
- Chrome
- Firefox
- Safari
- Edge
- 其他

- type: dropdown
id: os
attributes:
label: "移动端操作系统"
placeholder: "例如 iOS16.1"
label: 操作系统
options:
- Windows
- macOS
- Linux
- iOS
- Android
- 其他

- type: input
id: mobile-browser
id: version
attributes:
label: "浏览器"
placeholder: "例如 Chrome, Safari"
- type: input
id: mobile-version
label: 浏览器版本
placeholder: "例如:Chrome 108.0.5359.124"

- type: dropdown
id: priority
attributes:
label: "版本"
placeholder: "例如 108"
label: 优先级
description: 请根据问题的严重程度选择优先级
options:
-
-
-

- type: textarea
id: additional-info
attributes:
label: "其他"
placeholder: "如有其他内容,请提供"
label: 其他信息
placeholder: 您还想分享的其他信息?
111 changes: 70 additions & 41 deletions .github/ISSUE_TEMPLATE/bug-english.yml
Original file line number Diff line number Diff line change
@@ -1,75 +1,104 @@
name: Bug Report
description: Help us squash bugs in the Redefine theme.
description: Found a bug? Let us help you fix it!
title: "[BUG] "
labels: ["bug"]
assignees: ["EvanNotFound"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Fill out the details below to help us solve the issue quickly.
- type: checkboxes
id: pre-check
attributes:
label: Pre-Submission Checklist
description: Please ensure you've checked the following before submitting.
label: Quick Checklist
description: "Before submitting, please make sure you've done the following:"
options:
- label: "I've run `hexo clean`, but the problem persists."
- label: "[I've updated to the latest theme version](https://redefine-docs.ohevan.com/getting-started#update)"
- label: "[Post theme update, I've ensured the theme's configuration is in sync](https://redefine-docs.ohevan.com/getting-started#migrate-configuration)"
- label: "I've tried running `hexo clean` but the issue is still there"
required: true
- label: "[I'm using the latest version of the theme](https://redefine-docs.ohevan.com/getting-started#update)"
required: true
- label: "[I've updated my theme configuration after updating](https://redefine-docs.ohevan.com/getting-started#migrate-configuration)"
required: true

- type: textarea
id: bug-description
attributes:
label: "Describe the Bug"
description: "Provide a clear description. Include relevant details from the `_config.yml` in the hexo root and `_config.redefine.yml` or `_config.yml`. Redact any sensitive information."
label: "What's the issue?"
description: "Tell us what's happening. Please include your relevant config settings from `_config.yml` and `_config.redefine.yml` (remember to remove any sensitive info)."
validations:
required: true

- type: textarea
id: reproduce-steps
attributes:
label: "Reproduction Steps"
placeholder: "How did you come across this bug?"
label: "How can we reproduce this?"
placeholder: "Walk us through the steps to see this bug in action"
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: "Expected Behavior"
placeholder: "What were you expecting to happen?"
label: "What should have happened?"
placeholder: "Tell us what you expected to see"

- type: textarea
id: screenshots
attributes:
label: "Screenshots (if any)"
description: "Screenshots can help illustrate the problem."
- type: input
id: pc-os

- type: textarea
id: logs
attributes:
label: "Your Computer's OS"
placeholder: "e.g., macOS, Windows"
- type: input
label: "Related Logs"
description: "Please copy and paste any relevant log output. This will be automatically formatted as code, so no backticks are needed."
render: shell

- type: dropdown
id: pc-browser
attributes:
label: "Which Browser?"
placeholder: "e.g., Chrome, Safari"
label: "What browser(s) are you using?"
multiple: true
options:
- Chrome
- Firefox
- Safari
- Edge
- Other

- type: dropdown
id: pc-os
attributes:
label: "What operating system are you on?"
options:
- Windows
- macOS
- Linux
- iOS
- Android
- Other

- type: input
id: pc-version
attributes:
label: "Browser Version"
placeholder: "e.g., 108"
- type: input
id: mobile-device
attributes:
label: "Mobile Device Used"
placeholder: "e.g., iPhone 14"
- type: input
id: mobile-os
attributes:
label: "Mobile OS"
placeholder: "e.g., iOS16.1"
- type: input
id: mobile-browser
placeholder: "e.g., Chrome 108.0.5359.124"

- type: dropdown
id: priority
attributes:
label: "Mobile Browser"
placeholder: "e.g., Chrome, Safari"
- type: input
id: mobile-version
attributes:
label: "Browser Version"
placeholder: "e.g., 108"
label: "Priority"
description: "Please select the priority based on the severity of the issue."
options:
- Low
- Medium
- High

- type: textarea
id: additional-info
attributes:
label: "Anything Else?"
placeholder: "Any other information you'd like to share?"
label: "Anything else we should know?"
placeholder: "Add any other helpful context about the problem here"
44 changes: 39 additions & 5 deletions .github/ISSUE_TEMPLATE/enhancement-chinese.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,52 @@ title: "[功能建议]:"
labels: ["enhancement"]
assignees: ["EvanNotFound"]
body:
- type: markdown
attributes:
value: |
感谢您提出功能建议!请填写以下信息以帮助我们更好地理解您的想法。
- type: textarea
id: feature-description
attributes:
label: "功能描述"
description: "清晰地描述你想要的功能是怎么样的"
description: "请详细描述您想要的功能"
placeholder: |
1. 这个功能是什么?
2. 这个功能解决什么问题?
3. 您期望的使用场景是什么?
validations:
required: true

- type: textarea
id: implementation
attributes:
label: "实现建议"
description: "如果您对如何实现这个功能有想法,请在这里分享"
placeholder: "您认为这个功能应该如何实现?可以参考其他类似项目的实现方式。"

- type: textarea
id: screenshots
attributes:
label: "图片描述"
description: "可以用你的毕加索画作"
label: "设计参考"
description: "如果有类似功能的截图或设计稿,请在这里分享"
placeholder: "可以是草图、截图或其他参考资料"

- type: dropdown
id: priority
attributes:
label: "优先级"
description: "您认为这个功能的重要程度如何?"
options:
- 低(锦上添花)
- 中(较为重要)
- 高(急需解决)
validations:
required: true

- type: textarea
id: additional-info
attributes:
label: "其他"
placeholder: "如有其他内容,请提供"
label: "补充信息"
description: "还有什么需要补充的信息吗?"
placeholder: "例如:使用场景示例、潜在影响等"
Loading

0 comments on commit 114ec21

Please sign in to comment.