Skip to content

Commit 3be1cfd

Browse files
committed
optimize PR template
1 parent 2f70148 commit 3be1cfd

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Trivial changes like typos do not require a Github issue.
1313
-->
1414

1515
## 🔗 相关问题 / Related Issue
16+
1617
<!-- 请先创建 Issue 讨论,然后在这里链接 -->
1718
<!-- Please create an issue for discussion first, then link it here -->
1819

@@ -22,7 +23,6 @@ Trivial changes like typos do not require a Github issue.
2223
- [ ] 这是一个微小的修改(如错别字),不需要 Issue / This is a trivial change (like typo fix) that doesn't need an issue
2324

2425
## 📋 变更类型 / Type of Change
25-
请删除不适用的选项 / Please delete options that are not relevant
2626

2727
- [ ] 🐛 Bug 修复 / Bug fix (non-breaking change which fixes an issue)
2828
- [ ] ✨ 新功能 / New feature (non-breaking change which adds functionality)
@@ -33,10 +33,12 @@ Trivial changes like typos do not require a Github issue.
3333
- [ ] 🧹 代码清理 / Code cleanup
3434

3535
## 📝 变更目的 / Purpose of the Change
36+
3637
<!-- 详细描述这个变更的目的和必要性 -->
3738
<!-- Detailed description of the purpose and necessity of this change -->
3839

3940
## 📋 主要变更 / Brief Changelog
41+
4042
<!-- 列出主要的变更内容 -->
4143
<!-- List the main changes -->
4244

@@ -45,53 +47,64 @@ Trivial changes like typos do not require a Github issue.
4547
-
4648

4749
## 🧪 验证变更 / Verifying this Change
50+
4851
<!-- 描述如何验证这个变更是正确的 -->
4952
<!-- Describe how to verify that this change is correct -->
5053

5154
### 测试步骤 / Test Steps
55+
5256
1.
5357
2.
5458
3.
5559

5660
### 测试覆盖 / Test Coverage
61+
5762
- [ ] 我已经添加了单元测试 / I have added unit tests
5863
- [ ] 所有现有测试都通过 / All existing tests pass
5964
- [ ] 我已经进行了手动测试 / I have performed manual testing
6065

6166
## 📸 截图 / Screenshots
67+
6268
<!-- 如果适用,请添加截图来展示变更效果 -->
6369
<!-- If applicable, add screenshots to demonstrate the changes -->
6470

6571
## ✅ 贡献者检查清单 / Contributor Checklist
72+
6673
请确保你的 Pull Request 符合以下要求 / Please ensure your Pull Request meets the following requirements:
6774

6875
**基本要求 / Basic Requirements:**
76+
6977
- [ ] 确保有 GitHub Issue 对应这个变更(微小变更如错别字除外)/ Make sure there is a Github issue filed for the change (trivial changes like typos excluded)
7078
- [ ] 你的 Pull Request 只解决一个 Issue,没有包含其他不相关的变更 / Your PR addresses just this issue, without pulling in other changes - one PR resolves one issue
7179
- [ ] PR 中的每个 commit 都有有意义的主题行和描述 / Each commit in the PR has a meaningful subject line and body
7280

7381
**代码质量 / Code Quality:**
82+
7483
- [ ] 我的代码遵循项目的代码规范 / My code follows the project's coding standards
7584
- [ ] 我已经进行了自我代码审查 / I have performed a self-review of my code
7685
- [ ] 我已经为复杂的代码添加了必要的注释 / I have commented my code, particularly in hard-to-understand areas
7786

7887
**测试要求 / Testing Requirements:**
88+
7989
- [ ] 我已经编写了必要的单元测试来验证逻辑正确性 / I have written necessary unit-tests to verify the logic correction
8090
- [ ] 当存在跨模块依赖时,我尽量使用了 mock / I have used mocks when cross-module dependencies exist
81-
- [ ] 基础检查通过:`mvn -B clean package -Dmaven.test.skip=true` / Basic checks pass
91+
- [ ] 基础检查通过:`mvn -B clean package -Dmaven.test.skip=true``npm install --force && npm run build:pro` / Basic checks pass
8292
- [ ] 单元测试通过:`mvn clean install` / Unit tests pass
8393

8494
**文档和兼容性 / Documentation and Compatibility:**
95+
8596
- [ ] 我已经更新了相应的文档 / I have made corresponding changes to the documentation
8697
- [ ] 如果有破坏性变更,我已经在 PR 描述中详细说明 / If there are breaking changes, I have documented them in detail
8798
- [ ] 我已经考虑了向后兼容性 / I have considered backward compatibility
8899

89100
## 📋 附加信息 / Additional Notes
101+
90102
<!-- 任何其他相关信息,如已知问题、后续计划等 -->
91103
<!-- Any other relevant information, such as known issues, future plans, etc. -->
92104

93105
---
94106

95107
**审查者注意事项 / Reviewer Notes:**
108+
96109
<!-- 为审查者提供的特殊说明或需要重点关注的地方 -->
97110
<!-- Special instructions for reviewers or areas that need special attention -->

0 commit comments

Comments
 (0)