contributing

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Contributing Conventions

贡献规范

PR Title Format

PR标题格式

PR titles must follow the Conventional Commits spec. This is enforced by the

semantic-pull-request

CI check.

<type>[optional scope]: <description>

Allowed types:

Type	When to use
`feat`	New feature
`fix`	Bug fix
`ci`	CI/CD changes
`docs`	Documentation only
`refactor`	Code restructuring without behaviour change
`test`	Adding or fixing tests
`chore`	Maintenance (deps, configs, tooling)
`perf`	Performance improvement
`build`	Build system changes
`revert`	Reverts a previous commit

Do:

ci: retry apt-get installs to handle mirror sync failures
feat(grpo): add dataclass config defaults infrastructure
fix: preserve RAY_EXPERIMENTAL_NOSET_CUDA_VISIBLE_DEVICES

Don't:

[ci] fix: retry apt-get installs   ← area tags are not part of this convention
Update stuff
Fix bug

PR标题必须遵循Conventional Commits规范，这由

semantic-pull-request

CI检查强制实施。

<type>[optional scope]: <description>

允许的类型：

类型	使用场景
`feat`	新增功能
`fix`	修复Bug
`ci`	CI/CD变更
`docs`	仅文档更新
`refactor`	代码重构（不改变功能）
`test`	添加或修复测试用例
`chore`	维护工作（依赖、配置、工具）
`perf`	性能优化
`build`	构建系统变更
`revert`	回退之前的提交

正确示例：

ci: retry apt-get installs to handle mirror sync failures
feat(grpo): add dataclass config defaults infrastructure
fix: preserve RAY_EXPERIMENTAL_NOSET_CUDA_VISIBLE_DEVICES

错误示例：

[ci] fix: retry apt-get installs   ← 区域标签不属于此规范
Update stuff
Fix bug

Commit Sign-off

提交签名

All commits must be signed off with

-s

bash

git commit -s -m "fix: correct reward normalization"

所有提交必须使用

-s

参数进行签名：

bash

git commit -s -m "fix: correct reward normalization"

CI Triggering

CI触发

After pushing, trigger CI with:

/ok to test <full-commit-sha>

Use

git rev-parse HEAD

(not the short form) to get the full SHA.

推送代码后，使用以下命令触发CI：

/ok to test <full-commit-sha>

使用

git rev-parse HEAD

（而非短格式）获取完整SHA值。