第十四章 · 犀牛鸟竞赛贡献指南
这章为谁设计
你是犀牛鸟 2026 的参赛者,想知道「我第一周该做什么、能做什么、做不了什么」。
环境矩阵
| 你的环境 | 能做什么 | 不能做什么 |
|---|---|---|
| Mac(无 KVM) | 文档编写、Python SDK 示例、Go 组件代码阅读和单元测试 | 跑完整 microVM 端到端、性能测试 |
| Linux + KVM | 全功能——从构建到 microVM 启动到性能测试 | 无明显限制 |
| 云服务器(按需) | 全功能验证,按需启停控制成本 | 成本(裸金属 ~2-5 元/小时) |
现实:如果你只有 Mac,核心功能无法本地验证——但文档、SDK、Go 上层组件都可以做。犀牛鸟的贡献不要求每个 PR 都涉及底层 Rust 代码。
贡献路径分级
| 级别 | 方向 | 语言 | 预估耗时 |
|---|---|---|---|
| 零门槛 | 文档(Troubleshooting / Use Cases / Integration) | Markdown | 2-5 天/篇 |
| 低门槛 | Python SDK 示例、E2B 兼容性测试 | Python | 3-7 天 |
| 中门槛 | Go 组件(CubeMaster/Cubelet/CubeProxy) | Go | 1-2 周 |
| 高门槛 | Rust 核心(CubeShim/hypervisor/CubeAPI) | Rust | 2-4 周 |
推荐首选:Integration 文档(#244)
Integration 渠道完全为空(0 篇),而 CubeSandbox 的 examples/ 目录已有 12 个示例(OpenAI Agents、browser-sandbox、mini-rl-training、snapshot-rollback-clone 等)——这些示例可以直接转化为集成指南。竞争极小、价值极大。
文档 PR 硬性要求
- 必须同时提交中英文版本
- 文件名用英文 kebab-case
- 从
_template.md起步 - frontmatter 中英文对齐
- 一篇文章一个 PR,不混合
- commit 必须 DCO 签名(
git commit -s) - AI 生成的内容不能加
Signed-off-by——人类必须审查并以自己名义签名
第一周行动清单
第1天:环境准备
├── fork TencentCloud/CubeSandbox
├── clone 到本地,跑 docs/ VitePress 预览
└── 通读 CONTRIBUTING.md
第2天:选 issue + 调研
├── 从 #241/#243/#244 中选一个方向
├── 如果选 #244:读 examples/ 目录的 12 个示例
└── 如果选 #241:grep open issues 中的 bug 报告
第3天:写初稿
├── 复制 _template.md → 你的 slug.md
├── 同时创建中英文两个版本
└── frontmatter 对齐
第4-5天:验证 + 提 PR
├── VitePress 本地预览确认渲染正确
├── git commit -s -m "docs: add <slug>"
└── 开 PR,描述中 link 对应 issue
风险诚实评估
- 项目新(2026-04 首次公开,~6K star):好处是贡献空间大;风险是 API 可能快速迭代
- KVM 硬依赖:Mac 用户无法本地验证核心功能
- XFS 文件系统要求:Ubuntu/Debian 默认 ext4 需要额外配置
- 双语文档负担:所有文档 PR 必须中英文同时提交
- AI 署名限制:AI 生成的代码必须经人类审查,不能自动 DCO 签名
读完这章你应该能回答
- 我只有 Mac 能贡献什么?(文档、Python SDK 示例、Go 组件)
- 最高 ROI 的首选贡献是什么?(#244 Integration 文档——渠道完全为空)
- 文档 PR 的硬性要求有哪些?(双语、_template 起步、DCO 签名、一 PR 一篇)
- 项目有什么风险?(新项目 API 不稳定、KVM 依赖、XFS 要求)
导读目录:README.md 上一章:第十三章 · 技术挑战——这个领域为什么难做 下一章:第十五章 · 6 个项目的 AI 配置揭秘