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