Skip to content

Commit cf0a745

Browse files
committed
chore: update contributing file
1 parent 7f79a61 commit cf0a745

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,23 @@
44

55
## 方法
66

7-
如果您有新的示例或改进建议,
7+
如果您有新的示例或改进建议,请遵循以下步骤
88

99
1. Fork 本仓库到您的 Github 仓库空间下
10-
2. 在您的本地创建新分支 (git checkout -b feature/amazing-example)
11-
3. 基于 template/ 目录创建新的 Sample 工程
12-
4. 提交更改 (git commit -m 'feat(sample): add amazing example')
13-
5. 推送到分支 (git push origin feature/amazing-example)
14-
6. 在本仓库中创建 Pull Request 来申请合并您的变更
10+
2. 将您的 Fork 仓库 Clone 到本地(`git clone ...`
11+
3. **在您本地仓库的根目录中,安装 pre-commit 工具(`pip install pre-commit` & `pre-commit install`**
12+
4. 在您的本地创建新分支 (git checkout -b feature/amazing-example)
13+
5. **基于 template/ 目录创建新的 Sample 工程**
14+
6. 提交更改 (git commit -m 'feat(sample): add amazing example')
15+
7. 推送到分支 (git push origin feature/amazing-example)
16+
8. 在本仓库中创建 Pull Request 来申请合并您的变更
1517

1618
> [!IMPORTANT]
17-
> 请您务必遵守 `template` 目录下的文件结构和命名规范,并遵循 [README.md](https://github.com/volcengine/agentkit-samples/blob/main/template/README.md) 文件中的**二级标题**规范。缺少二级标题会导致您的提交无法通过 CI/CD 检查。
19+
> 请您务必遵守 `template` 目录下的文件结构和命名规范,并遵循 [README.md](https://github.com/volcengine/agentkit-samples/blob/main/template/README.md) 文件中的**二级标题**规范。
20+
>
21+
> 请您务必安装 `pre-commit` 工具,以确保您的提交符合规范。
22+
>
23+
> **未执行上述步骤,可能会导致您的提交无法通过 CI/CD 检查。**
1824
1925
## 审核
2026

0 commit comments

Comments
 (0)