维护者职责
Ansible 集合维护者是社区信任的贡献者,他们为项目做出重要且定期的贡献,并且在该相关领域表现出专业能力。集合维护者在集合范围内具有扩展权限。
Ansible 集合维护者会及时对他们维护的集合的 pull request 或问题提供反馈、回复或操作。他们还可以与 Ansible 社区团队和该集合的其他维护者协作,更新该集合的贡献者指南。
通常,集合维护者
根据社区行为准则行事。
订阅他们维护的集合存储库(在 GitHub 中单击 Watch > All activity)。
保持 README、开发指南和其他通用集合 维护良好的集合文档 的相关性。
审查和提交其他贡献者所做的更改。
向后移植 对稳定分支的更改。
解决问题或将问题分配给合适的贡献者。
发布集合.
确保集合符合Ansible 社区软件包集合要求。
跟踪 集合贡献者和维护者新闻 中宣布的更改,并根据这些更改更新集合。
订阅 Bullhorn 时事通讯 并向其提交新闻。
建立健康的社区,以增加集合周围的活跃贡献者和维护者的数量。
修改这些指南,以改善您自己和其他人的维护者体验。
多个维护者可以彼此分担责任。
如何成为维护者
有兴趣成为维护者并满足要求的人可以自我提名或由其他维护者提名。
要提名候选人,请在相关的集合存储库中创建一个 GitHub 问题。如果没有回应,则该存储库未被积极维护,或者当前的维护者没有添加候选人的权限,请在Ansible 社区论坛中创建一个主题。
作为集合维护者进行沟通
强烈建议维护者订阅“影响集合贡献者和维护者的更改” GitHub 存储库 和 Bullhorn 时事通讯。如果您有重要的事情要通过时事通讯宣布(例如,最近的发布),请查看 Bullhorn 以了解如何操作。
集合贡献者和维护者还可以通过以下方式进行沟通
适合他们集合的实时聊天和论坛主题,如果不存在,则使用常规的社区和开发者聊天频道。
相应存储库中的集合项目版块、问题和 GitHub 讨论。
贡献者峰会和 Ansible 社区日。
Ansiblefest 和本地聚会。
有关这些沟通渠道的更多详细信息,请参阅与 Ansible 社区沟通。
建立工作组沟通
工作组依赖于高效的沟通。项目维护者可以使用以下技术为工作组建立沟通
为您的项目请求一个新的工作组。
在项目
README.md
的贡献者部分中提供工作组详细信息和聊天室链接。鼓励贡献者加入论坛小组和聊天。
请参阅沟通指南,以了解有关实时聊天的更多信息。
社区话题
社区和指导委员会异步讨论并投票决定影响整个项目或其部分(包括集合和软件包)的社区话题。
分享您的意见并为这些话题投票,以帮助社区做出最佳决策。
贡献者峰会
季度 Ansible 贡献者峰会是一项全球性活动,为我们的贡献者提供了一个很好的机会,让他们可以相互见面、交流、分享想法,并看到在 Matrix 或 Libera Chat IRC 或 GitHub 上的消息背后还有其他真实的人。这给人一种社区感。当下一个贡献者峰会到来时,请关注Bullhorn 时事通讯的信息,邀请您认识的贡献者,并一起参与活动。
每周社区 Matrix/IRC 会议
社区和指导委员会在 #ansible-community
Libera.Chat IRC 频道或桥接的 #community:ansible.com 房间(位于 Matrix 上)的每周会议上聚集在一起,讨论重要的项目问题。加入我们!这是我们的时间表。
扩展集合社区
注意
如果您发现扩展社区或使其更强大的好方法,请编辑此部分,并分享您的想法,以便与其他集合维护者分享。
以下是一些您可以扩展集合周围社区的方法
邀请贡献者加入论坛小组和与您的项目相关的实时聊天。
拥有良好的文档,其中包含新贡献者的指南。
让人们感受到个人和单独的欢迎。
使用标签显示简单的修复,并将非关键的简单修复留给新人,并主动提供指导。
对问题、PR 和其他沟通保持响应。
定期进行 PR 日。
对违反社区行为准则的行为采取零容忍政策。
在你的
README
和CONTRIBUTING
文件中加入关于人们如何注册违反行为准则的信息。在你的
README
中包含贡献者可以快速提供帮助的方式和其他文档。添加并保持更新
CONTRIBUTORS
和MAINTAINERS
文件。创建一个置顶 issue,宣布该集合欢迎新的维护者和贡献者。
在活跃的贡献者中寻找新的维护者。
宣布你的集合欢迎新的维护者。
参加贡献者峰会并祝贺新的维护者。
鼓励新的贡献者
易于修复的项目是吸引和指导新贡献者的最佳方式。你应该对收到的问题进行分类,并使用诸如 easyfix
、waiting_on_contributor
和 docs
等标签进行标记。如果合适,不要自己修复这些琐碎的非关键性错误。相反,指导那些想要贡献的人。
对于一些容易修复的问题,你可以询问问题报告者是否愿意自己修复该问题,并提供创建 PR 的快速入门指南的链接。
定期进行拉取请求日。例如,你可以计划在每个月的最后一个星期五举行 PR 日,届时你和其他维护者会浏览所有未解决的问题和拉取请求,重点关注旧的拉取请求,询问是否可以提供帮助等等。如果有一些拉取请求看起来被放弃了(例如,自上次 PR 日以来,您提供的帮助没有得到回应),请宣布任何其他感兴趣的人都可以完成该拉取请求。
将满足要求的活跃贡献者晋升为维护者。定期审查贡献者的活动情况。
如果你的集合找到了新的维护者,请在 Bullhorn 新闻通讯中以及下一次贡献者峰会期间宣布这一事实,祝贺并感谢他们所做的工作。你可以提及自上次峰会以来所有被晋升的人。记得提前邀请其他维护者参加峰会。
鼓励贡献者的一些其他一般性指南
欢迎作者,并感谢他们提出的问题或拉取请求。
如果报告了一个非关键的易于修复的错误,请礼貌地要求作者自己修复它,并提供 创建你的第一个集合拉取请求的链接。
在提出更改建议时,尽量使用问题,而不是陈述。
在提出强制性更改时,请尽可能礼貌地提出,并提供文档参考。
如果你的建议是可选的或个人偏好问题,请明确说明。
当要求添加测试或进行复杂的代码重构时,请说明如果作者需要,欢迎他们寻求澄清和帮助。
如果有人提出了一个好主意,请提及或点赞。
合并后,感谢作者和审阅者的时间和精力。
请参阅集合 PR 的审核清单,了解在合并 PR 之前要检查的项目列表。
维护良好的集合文档
维护人员负责维护集合文档,以确保其符合Ansible 文档风格指南。这包括定期保持以下文档的准确性和更新:
符合Ansible 文档格式的集合模块和插件文档。
遵循集合文档格式的集合用户指南。
包含至少一个
README
和CONTRIBUTING
文件的存储库文件。
一个好的 README
包括对集合的描述,指向社区行为准则的链接,以及如何贡献的详细信息或指向 CONTRIBUTING
文件的指针。如果你的集合是 Ansible 的一部分(随 Ansible 软件包一起发布),请在集合的 README
顶部突出显示这一事实。
CONTRIBUTING
文件包括关于新的或持续的贡献者如何为该集合做出贡献的所有详细信息或指向详细信息的链接。CONTRIBUTING
文件应包括:
关于新贡献者指南的信息或链接,例如关于打开 PR 的快速入门。
关于贡献者要求的信息或链接,例如单元和集成测试要求。
你可以选择包括 CONTRIBUTORS
和 MAINTAINERS
文件,以列出集合贡献者和维护者。