提交者指南

这些指南适用于在 ansible 和 ansible-collections GitHub 组织中的存储库拥有提交权限的人员。

Ansible 核心 的提交者必须是红帽员工,并作为 Ansible 核心团队的成员。 Ansible 集合 的提交者是社区成员或 Ansible 工程师。请在提交之前阅读这些指南。

这些指南适用于所有人。同时,这不是一个流程文档。所以请使用良好的判断力。您被授予提交权限,因为我们信任您的判断力。

也就是说,明智地使用这份信任。

如果您滥用信任并破坏组件和构建等,信任级别就会下降,您可能会被要求不要提交,或者您可能会失去提交权限。

ansible-core 的功能、高级设计和路线图

作为核心团队成员,您是开发 路线图 的团队中不可或缺的一部分。请积极参与,并推动您希望看到的特性和修复。同时,请记住,红帽公司将为各种版本承诺某些特性、修复、API 等。红帽公司和 Ansible 团队必须按计划完成并发布这些更改。对用户、社区和客户的义务必须放在首位。由于这些承诺,如果您想自己开发的功能可能会不会被纳入发布版本,如果它会影响 Ansible 中的许多其他部分。

任何其他新功能和对高级设计的更改都应通过提议流程(待定)进行,以确保社区和核心团队有机会审查该想法并批准它。核心团队对根据提议将新功能合并到 Ansible 核心 中负有唯一责任。

Ansible 集合的功能、高级设计和路线图

集合维护者定义集合本身的功能、高级设计和路线图,并负责根据与他们社区讨论的提议将新功能合并到 Ansible 集合 中。

我们在 GitHub 上的工作流程

作为提交者,您可能已经知道这一点,但我们的工作流程构成了我们许多团队策略的基础。请确保您了解以下工作流程步骤

  • 将您想要进行工作的存储库分叉到您自己的个人存储库中

  • 在您需要提交的特定分支上工作

  • 创建回上游存储库的拉取请求,并标记您希望审查的人;指定某人为您的拉取请求的主要“所有者”

  • 根据提供的评论调整代码

  • 请存储库提交者中的某人进行最终审查并合并

提交者工作流程附录:

核心团队知道,这有时可能是一个艰难的过程。有时,团队会违反规则,直接提交或合并他们自己的拉取请求。本节是一套指南。如果您正在更改文档中的逗号,或进行非常小的更改,您可以根据自己的判断做出决定。这也是信任问题。该流程对于任何重大更改都至关重要,但对于小事或快速完成某事,请根据自己的判断做出决定,并确保团队中的其他人了解您的工作。

核心角色

  • 核心提交者:对于大多数事情都可以进行拉取请求,但我们应该有一个时间框。挂起的拉取请求可能会根据这些开发人员的判断合并。

  • 模块维护者:模块维护者拥有特定的模块,并通过当前的模块拉取请求机制拥有间接提交权限。

  • 集合维护者:集合维护者拥有特定的集合,并对它们拥有提交权限。每个集合都可以为其贡献设定自己的规则。

一般规则

拥有直接提交权限的个人被赋予了允许他们执行各种操作的权限——可能比我们写下来的还要多。与其说是规则,不如说是通用指南,拥有此权限的个人应使用其最佳判断力。

  • 不要

    • 直接提交。

    • 合并您自己的拉取请求。其他人应该有机会审查并批准拉取请求合并。如果您是核心提交者,对于非常小的更改,您在这里有一点回旋余地。

    • 忘记替代环境。考虑替代方案——是的,人们有糟糕的环境,但他们是最需要我们帮助的人。

    • 拖累您的社区团队成员。讨论您审查的任何拉取请求的技术优点。避免消极和人身攻击。有关成为优秀社区成员的更多指导,请阅读我们的 社区行为准则

    • 忘记维护负担。高维护功能可能不值得添加。

    • 破坏 playbook。始终牢记向后兼容性。

    • 忘记保持简单。复杂性会带来各种问题。

    • 压缩、尽可能避免合并,如有需要,使用 GitHub 的压缩提交或 cherry pick(bisect 感谢您)。

    • 保持活跃。在项目中没有任何活动(通过合并、分类、提交等)的提交者将被暂停其权限。

    • 考虑向后兼容性(回到“不要破坏现有的 playbook”)。

    • 编写 测试,并确保您正在审查的其他人的拉取请求得到很好的覆盖。包含测试的拉取请求比没有测试的拉取请求优先级更高,这些拉取请求应该包含测试。虽然并非所有更改都需要测试,但请确保为新功能、错误修复和功能更改添加测试。

    • 与其他提交者讨论,尤其是在您不确定某些事情时。

    • 编写文档!如果您的拉取请求是新功能或行为更改,请确保您已更新所有相关文档或已通知相关人员进行更新。它还有助于添加与此文档兼容的 ansible-corecollection 版本(以避免稳定版和开发版文档之间的混淆,为了向后兼容性等)。

    • 考虑范围,有时可以将修复进行泛化。

    • 保持简单,这样一来,就可以进行维护、调试和理解。

提交者应继续遵循 Ansible 社区其他成员遵循的相同社区和贡献指南。