Skip to content
jeasonzhang edited this page Oct 3, 2024 · 1 revision

项目贡献形式

技能图谱的主要形式为树形状的思维导图,每个树形分支的末端以链接的形式展现,欢迎使用 Markdown,思维导图等形式。

图谱汇聚各方优质资源,方便开发者通过图谱发散式学习领域内的优质知识,减少不必要的学习成本。

使用 Markdown 举个例子:

Ethereum

项目贡献流程

通过 issue-PR 的形式进行统一管理。

贡献流程如下:

  1. 任何人均可通过 issue 提出想要贡献的领域方向,需要在 issue 中对自己的贡献内容进行一个简短的描述,其中 issue 需标明 apply 标签,当 issue 审核通过后,repo maintainer 会更新该issue 的标签为 task + building,并在 README 中更新贡献领域;

  2. 除了申请内容,贡献者们也可以在 issue 中寻找 task 标签的 issue,并在下面留言认领任务,对于每一个 task,都对应如下的四种标签状态:

    1. task + recruiting: 正在招募贡献者,贡献者可以随意领取;
    2. task + building: 该任务已被认领且处于开发状态,请贡献者优先考虑其他任务,如果想贡献被认领的任务,请参考 maintaining 状态,如果任务异常或长期没有更新,maintainer 将视情况重新修改任务为 recruiting 状态;
    3. task + completed: 该任务已经完结,maintainer 将 merge 相关 PR,close 相关 issue;
    4. task + maintaining: 该任务处于维护状态。

    对于 maintaining 状态,做如下解释:

    maintaining 维护状态出现在某一任务 completed 之后,随着生态技术的不断进步,因此我们的技能图谱也要与时俱进,当某一图谱需要更新时,想要主动维护更新的贡献者可以提出 issue,并将状态标签标记为 apply,与贡献流程 1 一致;

  3. 提交 PR,是贡献者提交自己作品的唯一形式。当贡献者在 issue 中认领完 task 后,便可开启一个主题对应的 PR。

    对于新开启的 PR,贡献者需要:

    1. 首先要标明自己认领的任务编号,即 reference 到对应 issue;
    2. 如果内容比较多,建议各位贡献者分好 section 进行 commit,或者整个图谱写好后一次 commit;
    3. 当整个图谱完结后,请在 issue 中留言说明,maintainer 将会进入 review 阶段,任何 review 建议将通过 PR 中的留言进行记录;
    4. 当 review 通过并无其他问题,maintainer 将会 merge 该 PR 并修改 issue 状态、close 相关 issue。

项目进展

  • Web3 行业入门通识 @Leo
  • Solana 合约开发工程师 @小龙
  • Ethereum DAPP 开发工程师 @Tiny熊
  • Near 开发工程师 @Robert
Clone this wiki locally