Loading...

Back to Details

pr-workflow

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

PR Workflow Guide

PR工作流指南

Commit Practices

提交实践

Atomic commits. Small, focused, single purpose
Don't mix: logic + formatting, logic + refactoring
Good message = easy to write short description of intent

Learn

git rebase -i

for clean history.

原子提交：小巧、聚焦、单一目的
不要混合：逻辑+格式调整，逻辑+重构
良好的提交信息：简洁描述提交意图的内容

学习使用

git rebase -i

来维护清晰的提交历史。

PR Guidelines

PR指南

Keep PRs focused and small
Run relevant tests before submitting
Each commit tells part of the story

保持PR聚焦且体量小
提交前运行相关测试
每个提交都能讲述部分开发故事

CI Environment Notes

CI环境说明

If running as GitHub Action:

Max-turns limit in
```
.github/workflows/claude.yml
```
OK to commit WIP state and push
OK to open WIP PR and continue in another action
Don't spiral into rabbit holes. Stay focused on key task

如果作为GitHub Action运行：

```
.github/workflows/claude.yml
```
中有最大运行次数限制
可以提交并推送WIP（进行中）状态的代码
可以开启WIP PR并在另一个Action中继续开发
不要陷入无关细节，专注于核心任务

Security

安全注意事项

Never commit:

```
.env
```
files
Credentials
Secrets

绝对不要提交：

```
.env
```
文件
凭证信息
机密数据

Third-Party Dependencies

第三方依赖项

When adding:

Add license file under
```
licenses/
```
Update
```
NOTICE.md
```
with dependency info

添加依赖项时：

在
```
licenses/
```
目录下添加许可证文件
更新
```
NOTICE.md
```
，补充依赖项信息

External APIs/Tools

外部API/工具

Never guess API params or CLI args
Search official docs first
Ask for clarification if ambiguous

不要猜测API参数或CLI参数
优先查阅官方文档
如果有歧义，请求澄清