Skip to content

Commit d171f90

Browse files
authored
docs(contributing): update guidelines (#148)
[skip ci] * docs(contributing): update guidelines * docs(contributing): clarify fork * docs(contributing): sync translation * docs(contributing): add label and cc reminder * docs(contributing): remove ensure new branch from checklist
1 parent 5da9565 commit d171f90

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<!--
2+
Provide a general summary of your changes in the Title above.
3+
The PR title must start with `feat(): `, `docs(): `, `fix(): `, `style(): `, or `refactor(): `, `chore(): `. For example: `feat(component): add new feature`.
4+
If it spans multiple components, use the main component as the prefix and enumerate in the title, describe in the body.
5+
-->
6+
<!--
7+
在上方标题中提供您更改的总体摘要。
8+
PR 标题需以 `feat(): `, `docs(): `, `fix(): `, `style(): `, `refactor(): `, `chore(): ` 其中之一开头,例如:`feat(component): 新增功能`。
9+
如果跨多个组件,请使用主要组件作为前缀,并在标题中枚举、描述中说明。
10+
-->
11+
12+
## Description / 描述
13+
14+
<!-- Describe your changes in detail -->
15+
<!-- 详细描述您的更改 -->
16+
17+
## Motivation and Context / 背景
18+
19+
<!-- Why is this change required? What problem does it solve? -->
20+
<!-- 为什么需要此更改?它解决了什么问题? -->
21+
22+
<!-- If it fixes an open issue, please link to the issue here. -->
23+
<!-- 如果修复了一个打开的issue,请在此处链接到该issue -->
24+
25+
Closes #XXXX
26+
27+
<!-- or -->
28+
<!-- 或者 -->
29+
30+
Relates to #XXXX
31+
32+
## How Has This Been Tested? / 测试
33+
34+
<!-- Please describe in detail how you tested your changes. -->
35+
<!-- 请详细描述您如何测试更改 -->
36+
37+
## Checklist / 检查清单
38+
39+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
40+
<!-- 检查以下所有要点,并在所有适用的框中打`x` -->
41+
42+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
43+
<!-- 如果您对其中任何一项不确定,请不要犹豫提问。我们会帮助您! -->
44+
45+
- [ ] I have read the [CONTRIBUTING](https://github.com/OpenListTeam/OpenList/blob/main/CONTRIBUTING.md) document.
46+
我已阅读 [CONTRIBUTING](https://github.com/OpenListTeam/OpenList/blob/main/CONTRIBUTING.md) 文档。
47+
- [ ] I have formatted my code with `go fmt` or [prettier](https://prettier.io/).
48+
我已使用 `go fmt`[prettier](https://prettier.io/) 格式化提交的代码。
49+
- [ ] I have added appropriate labels to this PR (or mentioned needed labels in the description if lacking permissions).
50+
我已为此 PR 添加了适当的标签(如无权限或需要的标签不存在,请在描述中说明,管理员将后续处理)。
51+
- [ ] I have requested review from relevant code authors using the "Request review" feature when applicable.
52+
我已在适当情况下使用"Request review"功能请求相关代码作者进行审查。
53+
- [ ] I have updated the repository accordingly (If it’s needed).
54+
我已相应更新了相关仓库(若适用)。
55+
- [ ] [OpenList-Frontend](https://github.com/OpenListTeam/OpenList-Frontend) #XXXX
56+
- [ ] [OpenList-Docs](https://github.com/OpenListTeam/OpenList-Docs) #XXXX

0 commit comments

Comments
 (0)