mirror of
https://github.com/linyqh/NarratoAI.git
synced 2025-12-12 11:22:51 +00:00
docs: 添加 Pull Request 模板
添加了 .github/pull_request_template.md 文件,用于指导贡献者提交高质量的 Pull Request。模板包含了以下部分: - PR 类型- 描述 - 相关 Issue - 更改内容 - 测试 - 截图- 检查清单 - 补充说明 这将有助于提高项目的维护效率和代码审查质量。
This commit is contained in:
parent
0310798868
commit
bb4cea70e5
46
.github/pull_request_template.md
vendored
Normal file
46
.github/pull_request_template.md
vendored
Normal file
@ -0,0 +1,46 @@
|
||||
## PR 类型
|
||||
请选择一个适当的标签(必选其一):
|
||||
|
||||
- [ ] 破坏性变更 (breaking)
|
||||
- [ ] 安全修复 (security)
|
||||
- [ ] 新功能 (feature)
|
||||
- [ ] Bug修复 (bug)
|
||||
- [ ] 代码重构 (refactor)
|
||||
- [ ] 依赖升级 (upgrade)
|
||||
- [ ] 文档更新 (docs)
|
||||
- [ ] 翻译相关 (lang-all)
|
||||
- [ ] 内部改进 (internal)
|
||||
|
||||
## 描述
|
||||
<!-- 请提供对此次更改的清晰描述。为什么需要这个更改?它解决了什么问题? -->
|
||||
|
||||
## 相关 Issue
|
||||
<!-- 请链接相关的 issue(如果有)。例如:Fixes #123 -->
|
||||
|
||||
## 更改内容
|
||||
<!-- 详细描述具体更改了什么 -->
|
||||
|
||||
-
|
||||
-
|
||||
-
|
||||
|
||||
## 测试
|
||||
<!-- 描述如何测试你的更改 -->
|
||||
|
||||
- [ ] 单元测试
|
||||
- [ ] 集成测试
|
||||
- [ ] 手动测试
|
||||
|
||||
## 截图(如果适用)
|
||||
<!-- 如果是UI相关的更改,请提供截图 -->
|
||||
|
||||
## 检查清单
|
||||
|
||||
- [ ] 我的代码遵循项目的代码风格
|
||||
- [ ] 我已经添加了必要的测试
|
||||
- [ ] 我已经更新了相关文档
|
||||
- [ ] 我的更改不会引入新的警告
|
||||
- [ ] PR 标题清晰描述了更改内容
|
||||
|
||||
## 补充说明
|
||||
<!-- 任何其他相关信息 -->
|
||||
Loading…
x
Reference in New Issue
Block a user