Skip to content

维护参与指南

乱 edited this page Jan 8, 2020 · 4 revisions

维护参与指南

介绍

  1. 术业有专攻,你可以自由选择知识体系里擅长的知识点,编写导读、学习方式和资料推荐。
  2. 已经更新的知识点介绍不够完美?欢迎来完善喔

你能得到什么?

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

1. 我个人赞助赠送礼品
谷歌贴纸、书籍、生发水,还有其他想要的礼品可以提出来我去采购。每季度统计一次 pr,超过 5 个的私聊我礼品邮寄地址。

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

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

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

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

说明

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

步骤

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

第 0 步,发 issue 认领写作

issue 内容包括:写作知识点、擅长方向 、个人博客和个人介绍(用于后续给你加推广链接),点击这里发 issue 进行认领

第一步,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

写作要求

  1. 带有学习步骤或学习方式 不同的知识点学习方式和切入点不同,希望可以让初学者少走弯路。

  2. 资料要分类 给出的资料,顺序要从易到难,最好有分模块,比如背景篇、应用篇、原理篇。

  3. 其他见排版指南

范例参考:

资料入选要求

  1. 以读者为本的价值观,关注如何让读者理解知识;
  2. 尽量图文并茂,避免照本宣科;
  3. 如果有作者的启示和思考就更棒了!

最后

有更好的写作想法可以与我沟通,感谢!