Skip to content

Commit 09c7b7d

Browse files
committed
Add PR template
1 parent bef22ce commit 09c7b7d

File tree

1 file changed

+97
-0
lines changed

1 file changed

+97
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!--
2+
如果您正在寻求帮助,请先在我们的 QQ 群、微信公众号(群)中进行交流。
3+
If you're looking for help, please check our QQ group, WeChat group.
4+
5+
我们鼓励使用英文,如果不能直接使用,可以使用翻译软件,您仍旧可以保留中文原文。
6+
Please try to use English to describe your issue, or at least provide a snippet of English translation.
7+
8+
请不要在没有创建 Issue 的情况下创建 Pull Request。
9+
Please do not create a Pull Request without creating an issue first.
10+
11+
微小的变更(如错别字修复)不需要创建 Issue。
12+
Trivial changes like typos do not require a Github issue.
13+
-->
14+
15+
## 🔗 相关问题 / Related Issue
16+
<!-- 请先创建 Issue 讨论,然后在这里链接 -->
17+
<!-- Please create an issue for discussion first, then link it here -->
18+
19+
**Issue 链接 / Issue Link:** #
20+
21+
- [ ] 我已经创建了相关 Issue 并进行了讨论 / I have created and discussed the related issue
22+
- [ ] 这是一个微小的修改(如错别字),不需要 Issue / This is a trivial change (like typo fix) that doesn't need an issue
23+
24+
## 📋 变更类型 / Type of Change
25+
请删除不适用的选项 / Please delete options that are not relevant
26+
27+
- [ ] 🐛 Bug 修复 / Bug fix (non-breaking change which fixes an issue)
28+
- [ ] ✨ 新功能 / New feature (non-breaking change which adds functionality)
29+
- [ ] 💥 破坏性变更 / Breaking change (fix or feature that would cause existing functionality to not work as expected)
30+
- [ ] 📚 文档更新 / Documentation update
31+
- [ ] 🔧 重构 / Refactoring (no functional changes)
32+
- [ ] ⚡ 性能优化 / Performance improvement
33+
- [ ] 🧹 代码清理 / Code cleanup
34+
35+
## 📝 变更目的 / Purpose of the Change
36+
<!-- 详细描述这个变更的目的和必要性 -->
37+
<!-- Detailed description of the purpose and necessity of this change -->
38+
39+
## 📋 主要变更 / Brief Changelog
40+
<!-- 列出主要的变更内容 -->
41+
<!-- List the main changes -->
42+
43+
-
44+
-
45+
-
46+
47+
## 🧪 验证变更 / Verifying this Change
48+
<!-- 描述如何验证这个变更是正确的 -->
49+
<!-- Describe how to verify that this change is correct -->
50+
51+
### 测试步骤 / Test Steps
52+
1.
53+
2.
54+
3.
55+
56+
### 测试覆盖 / Test Coverage
57+
- [ ] 我已经添加了单元测试 / I have added unit tests
58+
- [ ] 所有现有测试都通过 / All existing tests pass
59+
- [ ] 我已经进行了手动测试 / I have performed manual testing
60+
61+
## 📸 截图 / Screenshots
62+
<!-- 如果适用,请添加截图来展示变更效果 -->
63+
<!-- If applicable, add screenshots to demonstrate the changes -->
64+
65+
## ✅ 贡献者检查清单 / Contributor Checklist
66+
请确保你的 Pull Request 符合以下要求 / Please ensure your Pull Request meets the following requirements:
67+
68+
**基本要求 / Basic Requirements:**
69+
- [ ] 确保有 GitHub Issue 对应这个变更(微小变更如错别字除外)/ Make sure there is a Github issue filed for the change (trivial changes like typos excluded)
70+
- [ ] 你的 Pull Request 只解决一个 Issue,没有包含其他不相关的变更 / Your PR addresses just this issue, without pulling in other changes - one PR resolves one issue
71+
- [ ] PR 中的每个 commit 都有有意义的主题行和描述 / Each commit in the PR has a meaningful subject line and body
72+
73+
**代码质量 / Code Quality:**
74+
- [ ] 我的代码遵循项目的代码规范 / My code follows the project's coding standards
75+
- [ ] 我已经进行了自我代码审查 / I have performed a self-review of my code
76+
- [ ] 我已经为复杂的代码添加了必要的注释 / I have commented my code, particularly in hard-to-understand areas
77+
78+
**测试要求 / Testing Requirements:**
79+
- [ ] 我已经编写了必要的单元测试来验证逻辑正确性 / I have written necessary unit-tests to verify the logic correction
80+
- [ ] 当存在跨模块依赖时,我尽量使用了 mock / I have used mocks when cross-module dependencies exist
81+
- [ ] 基础检查通过:`mvn -B clean package -Dmaven.test.skip=true` / Basic checks pass
82+
- [ ] 单元测试通过:`mvn clean install` / Unit tests pass
83+
84+
**文档和兼容性 / Documentation and Compatibility:**
85+
- [ ] 我已经更新了相应的文档 / I have made corresponding changes to the documentation
86+
- [ ] 如果有破坏性变更,我已经在 PR 描述中详细说明 / If there are breaking changes, I have documented them in detail
87+
- [ ] 我已经考虑了向后兼容性 / I have considered backward compatibility
88+
89+
## 📋 附加信息 / Additional Notes
90+
<!-- 任何其他相关信息,如已知问题、后续计划等 -->
91+
<!-- Any other relevant information, such as known issues, future plans, etc. -->
92+
93+
---
94+
95+
**审查者注意事项 / Reviewer Notes:**
96+
<!-- 为审查者提供的特殊说明或需要重点关注的地方 -->
97+
<!-- Special instructions for reviewers or areas that need special attention -->

0 commit comments

Comments
 (0)