git-workflow

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Chinese

Always respond in the same language the user is using. If the user asks in Chinese, respond in Chinese. If in English, respond in English.

Use Conventional Commits format:

<type>: <short description>

Type	When to use
`feat:`	New feature or contract
`fix:`	Bug fix
`refactor:`	Code restructure without behavior change
`test:`	Add or update tests
`docs:`	Documentation changes
`chore:`	Build config, dependency updates, toolchain
`security:`	Security fix or hardening

使用Conventional Commits格式：

<type>: <short description>

Run
```
git diff
```
to review all changes before staging
Stage specific files — avoid
```
git add .
```
to prevent committing
```
.env
```
or artifacts
Write concise commit message describing the why, not the what
Never add
Co-Authored-By
lines — commit messages should only contain the description
Only commit — never
```
git push
```
unless explicitly requested
Never push directly to main/master — always use feature branches

Every PR must include:

Section	Content
Change description	What was changed and why
Test results	`forge test` output (all pass)
Gas impact	`forge test --gas-report` diff for changed functions
Deployment impact	Does this affect deployed contracts? Migration needed?
Review focus	Specific areas that need careful review

每个PR必须包含以下内容：

模块	内容
变更描述	修改的内容以及修改原因
测试结果	`forge test` 输出（所有用例通过）
Gas影响	针对修改函数的 `forge test --gas-report` 差异对比
部署影响	是否影响已部署合约？是否需要执行迁移？
审查重点	需要重点仔细审查的特定区域

Scenario	Requirement
Standard changes	Minimum 1 maintainer approval
Security-related changes	Minimum 2 maintainer approvals
AI-generated code	Must pass manual review + `forge test` before merge
Contract upgrades	Requires full team review + upgrade simulation on fork

AI-generated code must pass
```
forge test
```
before committing
Always review AI output for: correct import paths, proper access control, gas implications
Include relevant file paths and test cases in AI prompts for better results
Run
```
forge fmt
```
after AI generates code to ensure consistent formatting