Skip to content

如何参与开源计划

Linxs edited this page Sep 15, 2020 · 4 revisions

如何推荐/自荐参与开源计划

掘金社区沟通了市面上的众多开源项目作者和企业,总结了以下几个国内开源生态遇到的一些问题:

  1. 企业/团队/个人的优秀开源项目没有有效的传播途径
  2. 优秀开源参与者过于分散,难以寻找理念相同的开发者共同创作
  3. 因语言问题导致的国内外优秀开源项目的开发者无法交流和推广

我们希望凭借掘金社区的几百万的优质开发者资源对开源项目进行一系列的支持,并作为一个长期项目助力开源事业的发展,与广大开发者共建开源新生态。

为了保持项目的中立性,本次掘金社区开源计划秉承 【源于开源,回馈开源】 的精神,采用 公开自治 的方式。 即除发起人为掘金外,项目从规划、设计、实施均来自于热爱开源精神的优秀开发者。

基本要求

综上,为了能够有一个优质优秀的开源库资源环境,所以我们也对开发者/开源项目提出了一些基本要求。

开源项目推荐/自荐的基本要求如下:

  • 近 3 个月内需要有更新且还在继续维护的开源库
  • 应有明确的应用场景、自洽的解决方案以及较高的项目质量
  • 或拥有含金量较高高的英文文献

操作指南

1. 成为【推荐者】

通过发 ISSUE 来成为【推荐者】,只有先成为掘金开源计划的【推荐者】才可以参与后续的校对/评审等更高级的内容。

发 ISSUE 的内容约定如下:

  1. 推荐的可以是 公司/团队/个人 的开源项目。
  2. ISSUE title:【推荐/自荐】开源项目名 - 一句话推荐简述
  3. ISSUE body:
    • 第一种方式:使用 ISSUE 预置模板编写
    • 第二种方式:ISSUE 中贴掘金文章连接,使用掘金编写好推荐文章后,在 沸点话题中选择优秀开源推荐标签(尽量使用 预置模板 方便采集数据,感谢🙏)

2. 流程标记

提交 ISSUE 后会就会进入一个流程状态,其中会有校对/评审/共建者对该推荐项目进行标签标记。

标签标记的具体内容与含义:

  1. 已查看: 具有相关工作内容的人员已查看此推荐内容
  2. 校对中: 校对人员正在校对内容
  3. 评审中: 此环节停留时间会稍长,因通常会有多个人员进行审核评估
  4. 已排期: 推荐内容已审核通过,近期期刊中会发布,因期刊每期都有自己的主题,该推荐项目会排至相关主题一期
  5. 已收录: 推荐内容已审核通过,下一期期刊中发布

特殊标签标记的具体内容与含义:

  • 已查看 + 校对中: 需要额外的人员进行参与校对
  • 已收录 + Close ISSUE: 本期已发布,发布后才开始累计积分

反向流程标签标记:

  • 校对中 + 退回修改: 相关人员会在 ISSUE 下给出 修改建议/方案,修改完成后 @ 校对人员即可,流程不会重置
  • 未通过: 即相关评审人员评审后如不符合推荐要求,未通过原因会在 ISSUE 中给予回复原因,所有评审参与者回复完后会将该 ISSUE 关闭

3. 如何提交推荐进入期刊

当推荐的内容已审核通过进入 已排期已收录 状态时,且有 PR 标签出现就需要做如下事情

fork 此仓库,并从 master 分支上 git checkout -b "文件夹/文件名" 一个新的分支来提交推荐的文章,完成后再把这个分支发 PR。

发送 Pull Request,PR 的标题为文章的中文标题,内容请注明对应的 ISSUE 链接,方便进行管理。

注意:发 PR 的时候请注意检查,一个 PR 只能有一篇文章,切勿两篇或多篇 合并到一个 PR。

4. 文案排版规则指北

【重要】 中文时排版请参考 文案排版规则指北