Skip to content

Commit c12efe3

Browse files
authored
docs(community): update pr templates (#529)
优化 PR 模板结构和检查项 增加 PR 中 AI 辅助披露说明和工具范围
1 parent dfacee1 commit c12efe3

1 file changed

Lines changed: 97 additions & 39 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 97 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,114 @@
11
<!--
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.
2+
PR title / PR 标题:
3+
- Use Conventional Commits: `type(scope): summary`
4+
- Allowed types: `feat`, `docs`, `fix`, `style`, `refactor`, `chore`
5+
- Scope is required by the current PR title check.
6+
- For breaking changes, add `!`: `feat(driver)!: change auth flow`
57
-->
8+
9+
## Summary / 摘要
10+
611
<!--
7-
在上方标题中提供您更改的总体摘要。
8-
PR 标题需以 `feat(): `, `docs(): `, `fix(): `, `style(): `, `refactor(): `, `chore(): ` 其中之一开头,例如:`feat(component): 新增功能`。
9-
如果跨多个组件,请使用主要组件作为前缀,并在标题中枚举、描述中说明。
12+
Briefly describe what changed and why.
13+
简要说明改了什么,以及为什么需要改。
1014
-->
1115

12-
## Description / 描述
16+
<!--
17+
- List user-visible behavior changes.
18+
- List important implementation changes.
19+
- Mention config, storage, API, or compatibility changes if any.
1320
14-
<!-- Describe your changes in detail -->
15-
<!-- 详细描述您的更改 -->
21+
- 列出用户可感知的行为变化。
22+
- 列出重要实现变化。
23+
- 如涉及配置、存储、API 或兼容性变化,请明确说明。
24+
-->
1625

17-
## Motivation and Context / 背景
26+
- [ ] This PR has breaking changes.
27+
/ 此 PR 包含破坏性变更。
28+
- [ ] This PR changes public API, config, storage format, or migration behavior.
29+
/ 此 PR 修改了公开 API、配置、存储格式或迁移行为。
30+
- [ ] This PR requires corresponding changes in related repositories.
31+
/ 此 PR 需要关联仓库同步修改。
1832

19-
<!-- Why is this change required? What problem does it solve? -->
20-
<!-- 为什么需要此更改?它解决了什么问题? -->
33+
Related repository PRs / 关联仓库 PR:
2134

22-
<!-- If it fixes an open issue, please link to the issue here. -->
23-
<!-- 如果修复了一个打开的issue,请在此处链接到该issue -->
35+
- OpenList:
36+
- OpenList-Docs:
2437

25-
Closes #XXXX
38+
## Related Issues / 关联 Issue
2639

27-
<!-- or -->
28-
<!-- 或者 -->
40+
<!--
41+
Use `Closes #123`, `Fixes #123`, or `Relates to #123`.
42+
Remove this section if not applicable.
43+
使用 `Closes #123`、`Fixes #123` 或 `Relates to #123`。
44+
不适用时请删除本节。
45+
-->
2946

30-
Relates to #XXXX
47+
## Testing / 测试
3148

32-
## How Has This Been Tested? / 测试
49+
<!--
50+
Describe commands, platforms, and manual checks.
51+
If not tested, explain why.
52+
53+
说明执行过的命令、测试平台和手动验证。
54+
如果未测试,请说明原因。
55+
-->
3356

34-
<!-- Please describe in detail how you tested your changes. -->
35-
<!-- 请详细描述您如何测试更改 -->
57+
- [ ] `go test ./...`
58+
- [ ] Manual test / 手动测试:
3659

3760
## Checklist / 检查清单
3861

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
62+
- [ ] I have read [CONTRIBUTING](https://github.com/OpenListTeam/OpenList/blob/main/CONTRIBUTING.md).
63+
/ 我已阅读 [CONTRIBUTING](https://github.com/OpenListTeam/OpenList/blob/main/CONTRIBUTING.md)
64+
- [ ] I confirm this contribution follows the repository license, contribution policy, and code of conduct.
65+
/ 我确认此贡献符合仓库许可证、贡献规范和行为准则。
66+
- [ ] I have formatted the changed code with `gofmt`, `go fmt`, or `prettier` where applicable.
67+
/ 我已按适用情况使用 `gofmt``go fmt``prettier` 格式化变更代码。
68+
- [ ] I have requested review from relevant maintainers or code owners where applicable.
69+
/ 我已在适用情况下请求相关维护者或代码所有者审查。
70+
71+
## AI Disclosure / AI 使用声明
72+
73+
<!--
74+
Please disclose any substantial AI assistance used in this PR.
75+
Minor AI assistance, such as typo fixes, autocomplete, formatting suggestions,
76+
or wording polish, does not need to be disclosed.
77+
Remove this section if not applicable.
78+
79+
请披露此 PR 中使用的重要 AI 辅助内容。
80+
轻微 AI 辅助,例如拼写修正、自动补全、格式建议或文字润色,无需披露。
81+
如不适用,请删除本节。
82+
83+
Deliberate non-disclosure may be treated as a trust and compliance issue.
84+
85+
故意隐瞒 AI 使用情况可能被视为信任与合规问题。
86+
-->
87+
88+
- [ ] This PR includes AI-assisted content.
89+
/ 此 PR 包含 AI 辅助内容。
90+
91+
Tools used / 使用工具:
92+
93+
- [ ] ChatGPT
94+
- [ ] Codex
95+
- [ ] GitHub Copilot
96+
- [ ] Claude
97+
- [ ] Gemini
98+
- [ ] Other (please specify) / 其他(请注明):
99+
100+
Usage scope / 使用范围:
101+
102+
- [ ] Code generation / 代码生成
103+
- [ ] Refactoring / 重构
104+
- [ ] Documentation / 文档
105+
- [ ] Tests / 测试
106+
- [ ] Translation / 翻译
107+
- [ ] Review assistance / 审查辅助
108+
109+
- [ ] I have reviewed and validated all AI-assisted content included in this PR.
110+
/ 我已审核并验证此 PR 中的所有 AI 辅助内容。
111+
- [ ] I have ensured that all AI-assisted commits include `Co-Authored-By` attribution.
112+
/ 我已确保所有 AI 辅助提交都包含 `Co-Authored-By` 归属信息。
113+
- [ ] I can reproduce all AI-assisted content included in this PR without any AI tools.
114+
/ 我可以在没有任何 AI 工具的情况下重现此 PR 中包含的所有 AI 辅助内容。

0 commit comments

Comments
 (0)