跳至内容

贡献指南

如何提供反馈

请在Github上提交问题。

行为准则

参见 CNCF 行为准则。

社区会议（每月）

每月一次的机会，供Workflows和Events的用户和维护者分享他们当前的工作，并了解路线图中的未来计划。欢迎加入我们！有关社区会议的信息、会议纪要和录音，请点击此处。

贡献者会议（每月两次）

为Workflows和Events的贡献者和维护者提供一个讨论当前工作和未来计划的机会。欢迎加入我们！ 详情请参阅贡献者会议文档获取会议记录、录像及更多信息。

Slack

您可以加入以下CNCF Slack频道：

角色

Argo 项目目前设有4个指定的角色：

  • 成员
  • 审阅者
  • 审批人
  • 负责人

审阅者和审批者角色可以选择限定到代码库的某个区域（例如用户界面或文档）。

Reviewers及以上角色的当前权限可在OWNERS中查阅。

如果您有兴趣正式加入Argo项目，请按照会员指南中的说明，在argoproj代码库中提交会员申请。

如何贡献

我们一直在寻找贡献者。

编写PR（拉取请求）

贡献者研讨会

如果您有兴趣参与贡献，请查阅以下资源：

本地运行

要在本地运行Argo Workflows进行开发：running locally。

提交

请参阅提交指南。

依赖项

依赖项会增加安全问题的风险，并带来持续的维护成本。

依赖项必须通过这些测试：

  • 一个强有力的使用案例。
  • 它拥有一个可接受的许可证（例如MIT）。
  • 它得到了积极的维护。
  • 它没有安全问题。

例如，我们是否应该添加fasttemplate，查看Snyk报告：

测试 结果
A strong use case. ❌ Fail. We can use text/template.
它拥有可接受的许可证（例如MIT） ✅ 通过。MIT许可证。
该项目得到积极维护。 ❌ 失败。项目已停止活动。
它没有安全问题。 ✅ 通过。没有已知的安全问题。

不，我们不应该添加那个依赖项。

测试策略

没有单元测试或端到端测试的变更不太可能被接受。请参阅拉取请求模板。

其他贡献

审核PR（Pull Request）

任何人都可以评审PR（拉取请求）。 如果您担任指定角色，并计划主导评审，请将自己添加为该PR的"Assignee"（负责人）。 如果您是Reviewer（评审员）或以下级别，在批准PR后，请向一位或多位Approver（批准人）及以上级别人员请求评审。

问题分类与排查

新发现的缺陷需要进行分类，以识别出优先级最高的那些。任何成员都可以对缺陷进行分类。

应用标签P0、P1、P2和P3，其中P0是最高优先级需要立即关注，其次是P1、P2，最后是P3。 如果出现新的P0问题，请通知#argo-wf-contributors Slack频道。

任何获得≥5个"👍"反应的bug至少应标记为P1优先级。 获得3-4个"👍"反应的bug至少应标记为P2优先级。 可通过按"👍"排序来查看bug。

如果确定问题是用户错误而非程序缺陷，请移除type/bug标签（如适用则同时移除type/regression标签）并替换为type/support标签。 如需从提交者处获取更多诊断信息，请添加problem/more information needed标签。

请仅将问题分配给成员。我们鼓励新贡献者直接处理PR而无需被分配。

陈旧性

只有带有problem/more information needed标签的问题和PR才会被视为陈旧内容。

如果作者未及时回应获取更多信息的请求，该问题或PR将被自动标记为problem/stale标签并收到机器人消息。 若后续仍无回应，将被自动关闭并标记为"未计划"。

更多详情请参阅Stale Action配置。

自动化操作

作为argo-project的成员（参见roles），您可以在PR上使用以下评论来触发操作：

  • /retest - 重新运行所有失败的测试用例
  • /test - 触发完整测试套件。 仅当测试套件未自动触发时用于PR - 这几乎总是浪费资源，并且不会让/retest无法通过的测试通过。
  • /cherry-pick - 在提交合并到目标分支后，将尝试进行cherry-pick操作。 此命令可在合并前使用，PR将在合并后创建；也可在合并后使用该命令，系统会立即尝试执行。

可持续发展努力

Argo Workflows正在招募更多评审员和审批人来帮助维持其发展。 详情请参阅可持续发展计划获取更多信息。

有问题吗？

Search on GitHub Discussions and Slack.