成为维护者
本指南面向贡献者。 这些特别的人已经为一个或多个 Jekyll 仓库做出过贡献,但目前还没有任何仓库的写入权限。你可能会觉得这里的内容很有趣,但它显然并不适合所有人。
所以,你想成为某个 Jekyll 项目的维护者?我们非常欢迎你!下面是我们希望社区成员在成为维护者之前具备的一些经验与参与方式。
1. 使用 Jekyll
既然你想维护 Jekyll,那就多使用它。
用它做各种奇怪的事情,也用它做正常的网站。
它运行得怎么样?有没有什么薄弱点?你是否发现产品中存在某些缺失,应该被补上?
2. 帮助分类处理 Issue
关注你感兴趣的仓库。
加入 Affinity Team,这样你就能收到与你感兴趣领域相关的项目通知。
当你收到一个尚未被维护者分类处理(triage)的 Issue 通知时,主动参与进去。
你能复现这个问题吗?你能找出修复方案吗?
更多技巧可以参考维护者指南中的Issue 分类处理。
每位维护者都喜欢那种在自己查看之前就已经被解决好的 Issue。😃
3. 编写文档
好的文档意味着:
- 用户困惑更少
- 需要分类处理的 Issue 更少
随着代码不断变化,文档也总是需要修复与更新。
在你日常使用产品时,多阅读文档,并在你认为有必要时提交修改。
4. 编写代码
作为维护者,你需要审核修改代码的 Pull Request。
因此,你应该对 Jekyll 代码库足够熟悉,能够自信地审核任何提交上来的 PR。
为了更熟悉代码库,最好的方式就是自己写代码并提交 Pull Request。
一个很好的起点是 Issue 列表中标记为 "bug" 的问题。
你可以:
- 先编写一个能够复现问题并失败的测试
- 然后修复代码
- 直到测试通过
5. 审核 Pull Request
可以先从每周审核一个 Pull Request 开始。
尽量留下详细评论,并遵循我们的 Pull Request 审核指南。
6. 主动提出申请!
创建一个 Issue,说明:
- 你对项目做出的贡献
- 为什么想成为维护者
使用 Issue 的好处是:
你可以方便地引用自己曾经:
- 帮助分类处理 Issue
- 编写代码与文档
- 审核 Pull Request
的相关记录。
如果你不习惯公开申请,也可以私下给任意维护者发送邮件。
我们非常希望继续扩大团队,也期待更多社区成员成为维护者!
在其它方面提供帮助
除了核心代码与插件代码的维护者之外,Jekyll 团队还包括论坛版主(moderators)。
这些热心的社区成员会查看发布在 https://talk.jekyllrb.com 上的话题,并确保:
- 分类正确
- 符合我们的行为准则(Code of Conduct)
如果你想成为论坛版主,请给某位维护者发送邮件,并附上你曾回答问题的链接,同时说明希望加入版主团队。
任何帮助我们都非常欢迎。