Skip to content

Commit bb2ee36

Browse files
ywh555hhhPlucky923
authored andcommitted
feat: Add default pull request template
This commit introduces a default pull request template stored at .github/PULL_REQUEST_TEMPLATE.md. The template is designed to guide contributors by prompting for: - Associated chapters/files - Type of changes made - A description of the modifications - Confirmation of local validation (autocorrect, mkdocs serve) This will help streamline the review process and ensure consistency in contributions.
1 parent 42adf00 commit bb2ee36

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/pull_request_template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## 关联章节/文件
2+
<!-- 请填写您修改的文档路径或代码文件路径,例如: -->
3+
- 文档路径:`docs/1-install/2-partition.md`
4+
5+
## 修改类型
6+
<!-- 请选择一项或多项,并用 [x] 标记 -->
7+
- [ ] 内容补充
8+
- [ ] 错别字/语句修正
9+
- [ ] 格式调整
10+
- [ ] 图片/附件更新
11+
- [ ] 代码示例修改
12+
- [ ] 其他 (请说明):
13+
14+
## 修改描述
15+
<!-- 请简要描述您本次修改的主要内容和原因 -->
16+
-
17+
-
18+
19+
## 本地验证
20+
<!-- 请确保您已在本地完成以下检查 -->
21+
- [ ] 已通过 `autocorrect .` (或 `autocorrect --lint .` 检查并通过)
22+
- [ ] 已执行 `mkdocs serve` 并在本地预览,确认页面渲染正常、链接有效、排版美观
23+
24+
## 附加说明 (可选)
25+
<!-- 如有其他需要说明的事项,请在此填写 -->

0 commit comments

Comments
 (0)