维护者职责
Ansible 集合维护者是社区信任的贡献者,他们对项目做出了重大且定期的贡献,并且已经证明自己是相关领域的专家。集合维护者在集合范围内拥有扩展权限。
Ansible 集合维护者会及时对拉取请求或他们维护的集合中的问题提供反馈、回复或操作。他们还可以与 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
文件。创建一个固定问题,宣布该集合欢迎新的维护者和贡献者。
在活跃的贡献者中寻找新的维护者。
宣布您的集合欢迎新的维护者。
参加贡献者峰会并祝贺新的维护者。
鼓励新的贡献者
简单修复项目是吸引和指导新贡献者的最佳方式。您应该对传入的问题进行分类,以便在适当的情况下用诸如easyfix
、waiting_on_contributor
和docs
之类的标签标记它们。不要自己修复这些微不足道的非关键错误。相反,指导想要做出贡献的人。
对于一些简单的修复问题,您可以询问问题报告者是否希望自己修复问题,并提供创建 PR 的快速入门指南的链接。
定期进行拉取请求日。例如,您可以计划在每个月的最后一个星期五进行 PR 日,届时您和其他维护者将审查所有未解决的问题和拉取请求,重点关注旧的请求,询问人们是否需要帮助等等。如果有看起来被放弃的拉取请求(例如,自从上次 PR 日以来,您对帮助请求没有响应),宣布任何其他感兴趣的人都可以完成该拉取请求。
将满足要求的活跃贡献者提升为维护者。定期审查贡献者的活动。
如果您的集合找到了新的维护者,请在牛角号新闻通讯和下一次贡献者峰会上宣布这一事实,并祝贺他们并感谢他们所做的工作。您可以提及自上次峰会以来提升的所有人员。请记住提前邀请其他维护者参加峰会。
鼓励贡献者的一些其他一般指南
欢迎作者,感谢他们提出问题或拉取请求。
如果报告了一个非关键的简单修复错误,请礼貌地要求作者自己修复它,并提供指向创建您的第一个集合拉取请求的链接。
在提出更改建议时,尽量使用问题而不是陈述。
在提出强制性更改建议时,请尽可能礼貌地提供文档参考。
如果您的建议是可选的或个人偏好问题,请明确说明。
在要求添加测试或进行复杂代码重构时,请说明作者如果需要,可以随时提出澄清和帮助请求。
如果有人提出一个好主意,请提及它或竖起大拇指。
合并后,感谢作者和审阅者的时间和努力。
有关在合并 PR 之前需要检查的项目列表,请参见集合 PR 的审查清单。
维护良好的集合文档
维护者负责维护集合文档,以确保其符合Ansible 文档风格指南。这包括定期保持以下文档的准确和更新
符合Ansible 文档格式的集合模块和插件文档。
遵循集合文档格式的集合用户指南。
存储库文件,其中至少包含一个
README
和CONTRIBUTING
文件。
一个好的README
包含集合的描述、指向社区行为准则的链接,以及有关如何贡献或指向CONTRIBUTING
文件的详细信息。如果您的集合是 Ansible 的一部分(与 Ansible 包一起提供),请在集合的README
顶部突出显示这一事实。
CONTRIBUTING
文件包含所有详细信息或指向详细信息的链接,说明新贡献者或现有贡献者如何为该集合做出贡献。CONTRIBUTING
文件应包括
有关新贡献者指南的信息或链接,例如关于打开 PR 的快速入门。
有关贡献者要求的信息或链接,例如单元测试和集成测试要求。
您可以选择包含一个CONTRIBUTORS
和MAINTAINERS
文件来列出集合贡献者和维护者。