Argo 社区贡献指南：如何参与这个开源项目的维护和发展
【免费下载链接】argo-helmArgoProj Helm Charts项目地址: https://gitcode.com/gh_mirrors/ar/argo-helm
Argo 社区贡献指南是帮助新手和普通用户参与 GitHub 加速计划 / ar / argo-helm 项目维护和发展的完整指南。该项目作为 ArgoProj Helm Charts 的集合，需要社区成员共同努力来确保其质量和持续发展。通过本指南，你将了解如何提交贡献、遵循开发规范以及参与项目的各个方面。
为什么参与 Argo 社区贡献
参与开源项目贡献不仅能提升你的技术能力，还能为全球开发者社区做出贡献。Argo 社区作为 Kubernetes 生态系统的重要组成部分，其 Helm Charts 的质量直接影响众多企业和开发者的使用体验。通过贡献，你可以：
- 改进 Argo 相关工具的部署体验
- 解决实际使用中遇到的问题
- 与行业专家交流学习
- 提升个人技术影响力
Argo 项目发布周期分析
项目的发布效率是衡量社区活跃度的重要指标。下面的图表展示了 Argo 各主要组件的 Helm Chart 发布时间与上游版本发布的时间差，红线表示 72 小时的 SLA 目标：
从图中可以看出，Argo CD 的 Helm Chart 发布时间大部分都能控制在 72 小时以内，偶尔出现的延迟正需要社区贡献者的参与来改善。
贡献的基本流程
1. 准备工作
首先，你需要将项目仓库克隆到本地：
git clone https://gitcode.com/gh_mirrors/ar/argo-helm然后，熟悉项目结构和各个组件的位置：
- 主要 Helm Charts 位于
charts/目录下，包括 argo-cd、argo-events、argo-rollouts 等 - 脚本文件位于
scripts/目录，包括文档生成、代码检查等工具
2. 提交 Pull Request
所有贡献都需要通过 Pull Request (PR) 提交，包括项目成员的提交也需要经过审核。提交 PR 时需要注意：
- 每个 PR 只针对一个 Chart 的修改，例如修改 argo-cd 和 argo-rollouts 应该分开提交
- PR 标题需要遵循 Conventional Commits 规范，格式为
类型(范围): 描述，如fix(argo-cd): Fix typo in values.yaml - 确保所有自动化检查通过，包括 lint 检查和测试
文档贡献指南
项目文档使用 helm-docs 工具自动生成，确保文档与 values.yaml 保持一致。
更新文档的步骤
- 编辑图表目录下的
README.md.gotmpl文件 - 运行文档生成脚本：
./scripts/helm-docs.sh- 将生成的
README.md文件一并提交
注意：不要直接编辑
README.md文件，因为它会被自动生成的内容覆盖。同时，确保将README.md.gotmpl添加到.helmignore文件中。
版本控制规范
每个 Chart 的版本遵循 semver 标准，版本号格式为主版本.次版本.补丁版本：
- 主版本：重大重构、不兼容的变更
- 次版本：新功能、主要应用更新或轻微不兼容变更
- 补丁版本：应用补丁更新、向后兼容的功能增强
更新应用版本的步骤
- 在
values.yaml中更新所有容器镜像版本 - 在
Chart.yaml中确保appVersion与容器镜像版本匹配，并更新version字段 - 在
Chart.yaml的注释部分添加更新日志，格式如下：
annotations: artifacthub.io/changes: | - kind: added description: 新增功能描述 - kind: fixed description: 修复问题描述测试指南
为确保 Chart 的质量，贡献者需要进行充分的测试。项目使用 Helm 的 Chart Testing 工具进行自动化测试。
手动运行测试
./scripts/lint.sh针对特定组件的测试
Argo Workflows 测试
kubectl create ns argo helm install charts/argo-workflows -n argo argo version然后按照 快速入门指南 运行示例工作流。
Argo CD 测试
# 清理环境 helm delete argo-cd --purge kubectl delete crd -l app.kubernetes.io/part-of=argocd # 安装依赖 helm repo add redis-ha https://dandydeveloper.github.io/charts/ helm dependency update # 安装测试 helm install argocd charts/argo-cd -n argocd --create-namespace kubectl port-forward service/argo-cd-argocd-server -n argocd 8080:443在新终端中：
argocd version --server localhost:8080 --insecure # 重置密码 kubectl -n argocd patch secret argocd-secret \ -p '{"stringData": { "admin.password": "$2a$10$hDj12Tw9xVmvybSahN1Y0.f9DZixxN8oybyA32Uy/eqWklFU4Mo8O", "admin.passwordMtime": "'$(date +%FT%T%Z)'" }}' argocd login localhost:8080 --username admin --password 'Password1!' # 创建并同步应用 argocd app create guestbook --dest-namespace default --dest-server https://kubernetes.default.svc --path guestbook --project default --repo https://github.com/argoproj/argocd-example-apps.git argocd app sync guestbook安全贡献
如果发现安全漏洞，应通过项目的安全选项卡私下报告，而不是公开 issue。项目维护者会尽快响应并协调问题的确认和修复。
对于不同组件的安全问题，可能需要向上游项目报告：
- Argo Workflows: 安全政策
- Argo Events: 安全政策
- Argo Rollouts: 安全政策
- Argo CD: 安全政策
- Argo CD Image Updater: 安全政策
进阶贡献：自动化脚本
项目的scripts/目录包含多种自动化工具，如：
update-argo-cd-crds.sh: 更新 Argo CD 的 CRDsupdate-argo-events-crds.sh: 更新 Argo Events 的 CRDsrelease-analysis/: 发布分析相关脚本和图表
贡献者可以改进这些脚本或添加新的自动化工具，提高项目的开发效率。
其他组件的发布时间分析
除了 Argo CD，其他组件的发布时间也展示了社区维护的活跃度：
这些图表显示了各组件的发布时间趋势，帮助贡献者了解哪些领域需要更多关注和支持。
总结
参与 Argo 社区贡献是一个双赢的过程，既可以提升自己的技术能力，也能为开源社区做出贡献。无论你是新手还是有经验的开发者，都可以通过提交文档改进、修复 bug、添加新功能等方式参与进来。记住，每个贡献都很重要，即使是小的改进也能帮助项目变得更好！
希望本指南能帮助你顺利开始 Argo 社区贡献之旅，期待看到你的第一个 Pull Request！ 🚀
【免费下载链接】argo-helmArgoProj Helm Charts项目地址: https://gitcode.com/gh_mirrors/ar/argo-helm
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
