Chaos Mesh 项目贡献指南：从代码修改到 PR 提交全流程

Chaos Mesh 项目贡献指南：从代码修改到 PR 提交全流程

chaos-mesh 项目地址: https://gitcode.com/gh_mirrors/cha/chaos-mesh

前言

Chaos Mesh 作为一款云原生混沌工程平台，其开源特性依赖于社区开发者的共同贡献。本文将详细介绍如何为 Chaos Mesh 项目贡献代码，从环境准备到最终 PR 合并的全过程。

开发前沟通

在开始重大功能开发前，建议先与核心团队沟通确认：

1. 避免重复工作：确保没有其他开发者正在实现相同功能
2. 获取设计指导：核心团队可以提供架构设计建议
3. 明确需求边界：帮助准确定义功能范围和验收标准

对于开发新的混沌实验类型，建议先阅读开发者指南了解基础架构。

开发环境准备

1. 代码库初始化

# 克隆个人fork的仓库
git clone git@github.com:${your_username}/chaos-mesh.git

# 添加上游仓库
cd chaos-mesh
git remote add upstream https://github.com/chaos-mesh/chaos-mesh

# 禁止直接推送到上游master
git remote set-url --push upstream no_push

2. 分支管理策略

# 同步最新代码
git fetch upstream
git checkout master
git rebase upstream/master

# 创建特性分支
git checkout -b myfeature

代码开发规范

1. 代码修改注意事项

• 遵循 Go 语言代码规范
• 添加必要的单元测试
• 更新相关文档
• 保持向后兼容性

2. CRD 相关修改

当修改 CRD 结构体后，需要重新生成 YAML 文件：

make generate
make manifests/crd.yaml

3. 代码质量检查

提交前必须通过静态检查：

make check  # 包括格式检查、lint检查等

测试验证流程

1. 单元测试

make test  # 运行所有单元测试

2. 本地集成测试

环境准备

推荐使用 kind 创建本地 Kubernetes 集群：

# 安装依赖
./install.sh --local kind --dependency-only

# 验证安装
kind --version
kubectl version

部署 Chaos Mesh

./hack/local-up-chaos-mesh.sh  # 自动构建并部署

测试要点

• 验证新功能在真实集群中的表现
• 检查日志是否有异常
• 确保回滚机制正常工作

提交代码

1. 代码同步

git fetch upstream
git rebase upstream/master  # 解决可能的冲突

2. 提交规范

git add -A
git commit --signoff  # 必须签署DCO

提交信息应包含：

• 修改的模块
• 变更内容
• 相关Issue编号(如有)

3. 推送代码

git push -f origin myfeature

PR 创建与评审

1. PR 创建要点

• 清晰描述变更内容
• 关联相关Issue
• 提供测试验证结果
• 说明兼容性影响

2. 评审流程

• 至少需要两位核心维护者批准
• 可能需要多次迭代修改
• 关注点包括：
  • 功能正确性
  • 代码质量
  • 文档完整性
  • 测试覆盖率

结语

通过遵循上述流程，开发者可以高效地为 Chaos Mesh 项目贡献代码。记住，高质量的贡献不仅在于代码本身，还包括完善的测试、文档和良好的沟通。期待您的贡献能够帮助 Chaos Mesh 成为更强大的混沌工程平台。

chaos-mesh 项目地址: https://gitcode.com/gh_mirrors/cha/chaos-mesh