mirror of
https://github.com/hicccc77/WeFlow.git
synced 2026-03-24 23:06:51 +00:00
issue模板
This commit is contained in:
59
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
59
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
name: " 报告 Bug"
|
||||||
|
description: "代码出现了非预期的问题、崩溃或报错"
|
||||||
|
title: "[Bug]: "
|
||||||
|
labels: ["type: bug"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
请提供尽可能多的细节,这将帮助我们更快定位 `type: bug`。
|
||||||
|
- type: checkboxes
|
||||||
|
id: pre-check
|
||||||
|
attributes:
|
||||||
|
label: 提交前自测
|
||||||
|
description: 请务必确认以下事项:
|
||||||
|
options:
|
||||||
|
- label: 我已经查阅了文档,并且搜索过现有的 Issues,确认这不是一个重复问题。
|
||||||
|
required: true
|
||||||
|
- label: 我使用的是当前最新的版本。
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: 问题描述
|
||||||
|
description: 请清晰、明确地描述你遇到了什么问题。
|
||||||
|
placeholder: 当我执行...操作时,程序崩溃了,或者输出了不正确的结果...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction
|
||||||
|
attributes:
|
||||||
|
label: 复现步骤
|
||||||
|
description: 提供精确的步骤,帮助我们复现该问题。如果可能,请提供最小复现代码协助我们的定位问题。
|
||||||
|
placeholder: |
|
||||||
|
1. 运行命令 '...'
|
||||||
|
2. 点击 '...'
|
||||||
|
3. 发现问题 '...'
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: 预期行为
|
||||||
|
description: 你期望看到什么结果?
|
||||||
|
placeholder: 程序应该正常输出...而不是崩溃。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: 报错日志或截图
|
||||||
|
description: 请提供终端报错信息、浏览器 Console 日志,或直接将截图拖入此处。
|
||||||
|
render: shell
|
||||||
|
- type: input
|
||||||
|
id: environment
|
||||||
|
attributes:
|
||||||
|
label: 运行环境
|
||||||
|
description: 你的操作系统、软件版本、依赖环境、系统架构等(如:Windows 11, Node v18.16.0)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
4
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
4
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
contact_links:
|
||||||
|
- name: 🤔 找不到合适的模板?
|
||||||
|
about: 如果你只是想闲聊或者你的问题不属于上述任何分类,请前往我们的的Telegram频道与我们交流。
|
||||||
24
.github/ISSUE_TEMPLATE/docs.yml
vendored
Normal file
24
.github/ISSUE_TEMPLATE/docs.yml
vendored
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
name: " 文档反馈"
|
||||||
|
description: "文档存在错别字、描述不清晰或缺少必要的示例"
|
||||||
|
title: "[Docs]: "
|
||||||
|
labels: ["type: docs"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
优秀的文档和代码一样重要。感谢你帮助我们完善文档!
|
||||||
|
- type: input
|
||||||
|
id: doc-link
|
||||||
|
attributes:
|
||||||
|
label: 相关文档链接
|
||||||
|
description: 请提供存在问题的文档 URL 或具体文件路径。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: issue-desc
|
||||||
|
attributes:
|
||||||
|
label: 问题描述与建议
|
||||||
|
description: 文档哪里写错了?或者你建议补充什么内容?
|
||||||
|
placeholder: 在 "快速开始" 章节中,第三步的命令拼写错误,应该改为...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
25
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
Normal file
25
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
Normal file
@@ -0,0 +1,25 @@
|
|||||||
|
name: "功能与体验优化"
|
||||||
|
description: "对现有的功能逻辑进行优化,或改进用户体验"
|
||||||
|
title: "[Enhancement]: "
|
||||||
|
labels: ["type: enhancement"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
持续优化是项目进步的动力!请告诉我们哪个现有功能可以做得更好。
|
||||||
|
- type: textarea
|
||||||
|
id: target
|
||||||
|
attributes:
|
||||||
|
label: 目标功能
|
||||||
|
description: 你希望优化的功能或模块是哪一个?
|
||||||
|
placeholder: 例如:当前的导出功能 / 某个页面的交互...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: improvement
|
||||||
|
attributes:
|
||||||
|
label: 优化建议
|
||||||
|
description: 你认为应该怎么改?这会带来什么好处(如:性能提升、减少点击次数、视觉更美观)?
|
||||||
|
placeholder: 我建议将...改成...,这样可以将处理速度提升一倍。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
35
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
35
.github/ISSUE_TEMPLATE/feature.yml
vendored
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
name: "全新功能请求"
|
||||||
|
description: "提议一个目前项目中完全没有的新特性"
|
||||||
|
title: "[Feature]: "
|
||||||
|
labels: ["type: feature"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
感谢你为项目提供新想法!详细的需求描述能极大地增加该功能被采纳的几率。
|
||||||
|
- type: textarea
|
||||||
|
id: motivation
|
||||||
|
attributes:
|
||||||
|
label: 需求背景 / 动机
|
||||||
|
description: 为什么需要这个功能?你目前遇到了什么痛点?
|
||||||
|
placeholder: 目前我在做...事情时,必须手动处理,非常不方便。如果能有...功能就太好了。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: 期望的解决方案
|
||||||
|
description: 请详细描述你希望这个新功能是什么样的,它是如何工作的?
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: alternatives
|
||||||
|
attributes:
|
||||||
|
label: 备选方案 (可选)
|
||||||
|
description: 你目前在使用什么临时的替代方案?或者你有没有考虑过其他的实现方式?
|
||||||
|
- type: checkboxes
|
||||||
|
id: help-wanted
|
||||||
|
attributes:
|
||||||
|
label: 参与贡献
|
||||||
|
options:
|
||||||
|
- label: 我有能力且愿意提交 Pull Request 来实现这个功能!(我们会为你打上 `help wanted` 标签)
|
||||||
29
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
29
.github/ISSUE_TEMPLATE/question.yml
vendored
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
name: "使用答疑"
|
||||||
|
description: "关于如何配置、如何使用项目的求助"
|
||||||
|
title: "[Question]: "
|
||||||
|
labels: ["type: question"]
|
||||||
|
body:
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
在提问之前,请确保你已经仔细阅读过我们的官方文档。
|
||||||
|
- type: textarea
|
||||||
|
id: question
|
||||||
|
attributes:
|
||||||
|
label: 你的问题是什么?
|
||||||
|
description: 请清晰地描述你的疑问。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: attempts
|
||||||
|
attributes:
|
||||||
|
label: 你做过哪些尝试?
|
||||||
|
description: 请告诉我们你已经试过了什么方法,避免我们提供重复的建议。
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: code-snippet
|
||||||
|
attributes:
|
||||||
|
label: 相关代码配置
|
||||||
|
description: 请粘贴你当前的配置文件或调用的代码片段。
|
||||||
|
render: javascript
|
||||||
Reference in New Issue
Block a user