Skip to content

Commit b8d8c38

Browse files
authored
docs: update pull request template for clarity and completeness (#45)
* docs: update pull request template for clarity and completeness * docs: fix
1 parent 292e42f commit b8d8c38

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,28 @@
11
## Description
22

3-
> Please include a summary of the change and which issue is fixed.
4-
>
5-
> 请介绍你的修改,并说明它修复了哪个 issue.
3+
<!--
4+
Please include a summary of the changes below;
5+
Fill in the issue number that this PR addresses (if applicable);
6+
Mention the person who will review this PR (if you know who it is);
7+
Replace (summary), (issue), and (reviewer) with the appropriate information (No parentheses).
68
7-
Fix # (issue)
9+
请在下方填写更改的摘要;
10+
填写此 PR 解决的问题编号(如果适用);
11+
提及将审查此 PR 的人(如果您知道是谁);
12+
替换 (summary)、(issue) 和 (reviewer) 为适当的信息(不带括号)。
13+
-->
14+
15+
Summary: (summary)
16+
17+
Fix: #(issue)
18+
19+
Reviewer: @(reviewer)
820

921
## Checklist:
1022

1123
- [ ] I have performed a self-review of my own code | 我已自行检查了自己的代码
12-
- [ ] I have commented my code, particularly in hard-to-understand areas | 我已对代码进行了注释,特别是在难以理解的地方
24+
- [ ] I have commented my code in hard-to-understand areas | 我已在难以理解的地方对代码进行了注释
1325
- [ ] I have added tests that prove my fix is effective or that my feature works | 我已添加测试以证明我的修复有效或功能正常
14-
- [ ] I have added necessary documentation (if appropriate) | 我已添加必要的文档(如果有必要)
26+
- [ ] I have added necessary documentation (if applicable) | 我已添加必要的文档(如果适用)
27+
- [ ] I have linked the issue to this PR (if applicable) | 我已将 issue 链接到此 PR(如果适用)
28+
- [ ] I have mentioned the person who will review this PR | 我已提及将审查此 PR 的人

0 commit comments

Comments
 (0)