Skip to content

维护参与指南

乱 edited this page Jan 8, 2020 · 4 revisions

维护参与指南

介绍

术业有专攻,你可以自由选择知识体系里擅长的知识点,编写导读、学习方式和资料推荐。

你能得到什么?

参与维护、翻译的小伙伴:

1. 我个人赞助赠送礼品
谷歌贴纸、书籍、生发水,还有其他想要的礼品可以提出来我去采购。

2. 输出倒逼输入
检验自己知识点是否真正地掌握牢固了。

3. 获得我的私人写作指导
本人统筹过全公司 app 端技术分享,把控分享质量,累积了一点点写作经验,希望对大家有所帮助。

4. 影响力
随着项目的曝光度提升,你的头像也能出现在趋势榜单上面。

5. 个人博客的推广机会
在流量最大的README页面上,推广你的博客。

说明

本项目是一个长期计划,所以不管你是 996、997 甚至是 007,不用担心没有时间哟,只要参与了,你就是参与过1.6K Star开源项目的人了! 简历上不怕没东西写了。

步骤

那么,要怎么才能参与这个项目呢?

第一步,fork 本项目

点击右上角的Fork,让自己的repo列表里也有本项目

第二步,编辑项目

想要编辑,你有两种方式可以选择:

1. 在线编辑

  • 步骤
  1. 打开SUMMARY目录文件,选取要编辑的知识点。

  2. 修改目录的 md 链接

  3. 上传 md 文件

进入刚刚的目录空间,点击 Upload file

  • 优点 简单、快速

  • 缺点 没法使用 gitbook 的本地预览功能,上传后需要等几分钟进入在线gitbook查看效果。

2. clone 到本地

如果觉得项目太大,全部 clone 太耗时,可以指定克隆深度,只克隆最近某几次commit,详细步骤见:如何处理git项目过大的问题

  • 步骤
  1. 本地打开 SUMMARY.md 目录文件,选取要编辑的知识点。

  1. 修改目录的 md 链接

  2. md 文件放在本地对应的目录下

  3. 根目录运行gitbook serve命令,可以打开 localhost:4000 查看本地效果

  • 优点 可以本地预览效果

  • 缺点 clone 比较耗时

第三步,提交代码

如果你是 clone 到本地编辑,需要 commit 并 pull 提交到自己的分支上,如果你是在线编辑,则忽略本步骤。

第四步,编写 pr

在自己项目页面左侧,点击 New pull requests

跳转到一个新页面,这个页面展示了你做了那些改动,可以在底下看到,然后再点击 Create pull request 按钮,就完成一次 Pull Requests 了。

第五步,等待我merge就可以啦

请各位参与维护的小伙伴在github资料上留下邮箱,以便添加contributor to receive donation

写作和资料审查要求

Clone this wiki locally