issue template

This commit is contained in:
YILING0013
2025-02-03 11:14:34 +08:00
parent 73a9b79686
commit d1f739c051
3 changed files with 173 additions and 0 deletions
+65
View File
@@ -0,0 +1,65 @@
# Contributing to This Project
首先,感谢你愿意为本项目贡献力量!在提交任何形式的反馈或 Pull Request 之前,请先阅读以下内容。
---
## 一、反馈类型说明
1. **代码问题(Code Issue**
- 仅限与项目代码本身相关的问题:如编译失败、运行报错、逻辑缺陷等。
- 反馈之前,请确认该问题与你的环境或配置无关。
- 如果确认是代码本身导致的错误,请使用 [代码问题反馈模板](?template=code_issue.yml)。
2. **意见或建议(Opinion / Enhancement**
- 如果你有关于功能新增、代码重构、性能优化或其他方面的意见或建议,请使用 [意见/建议模板](?template=opinion.yml)。
- 我们会积极审阅并讨论可行性,但可能不会立刻实现,视项目计划而定。
3. **接口/配置/部署等问题**
- 本项目不针对接口配置、环境部署或第三方服务的参数设置等问题提供支持。
- 遇到此类问题,请阅读官方文档、社区讨论区或自行搜索相关信息。
---
## 二、在提交 Issues 之前
1. **搜索现有的 Issues**
- 避免重复提交相同问题。
- 如果发现类似问题可以补充你的信息或在对应 Issue 下评论。
2. **提供尽可能详细的信息**
- 提交问题时,尽量提供可复现的步骤、日志信息、环境说明等。
- 提交意见或建议时,需要清楚说明理由和期望。
3. **保持尊重与礼貌**
- 请尊重项目维护者和其他贡献者。
- 交流中请使用恰当、礼貌的语言。
---
## 三、Pull Request 提交指南
1. **先 Fork 再修改**
- 在你自己的 Fork 中进行修改和测试。
- 确保修改内容不会引入新的 Bug。
2. **遵守代码风格**
- 保持原有代码风格,遵循项目的 Lint 规则(如有)。
- 减少不必要的格式改动,保证可读性。
3. **更新文档或注释**
- 如果你的修改影响到了文档或注释,请及时补充或更新。
4. **描述清楚修改内容**
- Pull Request 标题与描述中需包含本次修改的目的、解决的问题以及修改的主要内容。
---
## 四、其他说明
- 我们对所有 Issue 和 Pull Request 均会尽量及时处理,但无法保证立即回复。
- 对于不符合上述规则的 Issue 或 Pull Request,我们保留关闭或忽略的权利。
如果你对上述要求有任何疑问,欢迎在意见区进行讨论。再次感谢你的贡献!
---
+60
View File
@@ -0,0 +1,60 @@
name: "代码问题反馈"
description: "此模板仅用于反馈代码相关问题,例如出现编译错误、运行报错、逻辑缺陷。"
title: "[Code Issue]: "
labels: ["bug", "code issue"]
assignees: []
body:
- type: markdown
attributes:
value: |
**⚠ 注意:此处仅受理代码本身的问题,包括但不限于编译错误、运行报错、逻辑异常等。**
**如果是接口配置或环境部署等问题,请自行阅读文档或在讨论区寻求帮助。**
**如果是意见或建议,请使用 [意见模板](?template=opinion.yml)。**
感谢你的配合!
- type: textarea
id: description
attributes:
label: "问题描述"
description: "请清晰、简要地描述代码出现的问题。"
placeholder: "例如:运行时报错xxx,或逻辑存在xxx。"
validations:
required: true
- type: textarea
id: steps
attributes:
label: "复现步骤"
description: "请提供完整的复现步骤,以便我们定位和解决问题。"
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: input
id: environment
attributes:
label: "环境信息"
description: "如编译器、操作系统、依赖版本等。"
placeholder: "示例:Windows 10, Node.js v14, Python 3.9, etc."
- type: textarea
id: logs
attributes:
label: "日志信息(如适用)"
description: "如果有报错日志或截图,可以贴在此处。"
placeholder: "请粘贴日志内容或相关截图链接(可选)"
validations:
required: false
- type: textarea
id: additional
attributes:
label: "补充信息"
description: "如果有更多信息,可在此补充。"
placeholder: "任何与问题相关的额外背景说明..."
validations:
required: false
+48
View File
@@ -0,0 +1,48 @@
name: "意见或建议"
description: "如果你有对项目的需求、功能建议、或其他意见,请使用此模板。"
title: "[Opinion]: "
labels: ["enhancement", "discussion"]
assignees: []
body:
- type: markdown
attributes:
value: |
**⚠ 注意:此处不用于反馈代码报错或编译问题,如果是纯代码报错或逻辑问题,请使用 [代码问题反馈模板](?template=code_issue.yml)。**
感谢你的宝贵意见或建议,我们会酌情采纳!
- type: textarea
id: suggestion
attributes:
label: "意见/建议内容"
description: "请简要描述你的想法或建议。"
placeholder: "例如:希望新增xx功能,或者修改xx逻辑。"
validations:
required: true
- type: textarea
id: reason
attributes:
label: "为什么需要这个功能或修改?"
description: "简单说明你提出此意见/建议的原因或背景需求。"
placeholder: "例如:在实际项目中遇到xx需求场景;希望提升xx效率;等等。"
validations:
required: true
- type: input
id: relevance
attributes:
label: "相关链接或参考"
description: "如果你有看到类似实现或参考资料,可在此提供链接。"
placeholder: "例如:相关文档链接、RFC、规范文档等"
validations:
required: false
- type: textarea
id: additional
attributes:
label: "补充信息"
description: "如果有更多信息,可在此补充。"
placeholder: "任何与意见或建议相关的额外说明..."
validations:
required: false