一起来找茬-十分钟成为 《TiDB in Action》审稿作家

还记得月初的那个周末,疫情之下迎来的阳春三月,我们虽然无法迎着春风去看红花绿柳,但是通过参加 PingCAP 组织的直播写书新游戏,我们一起度过了两天充实的宅家生活。

在这个活动中,我们一共招募了 102 位 TiDB 深度用户一共完成了 147 章节的编写。在之后的两周中,我们没有就此放慢脚步,紧锣密鼓地召集了公司内部及外 5 名专家成员完成了第一版的校验工作,重点针对排版、技术要点进行校验和审核。

如今,本书已初具模样,仿佛一个六个月的胎儿,电子版虽未面世,却已经可以用四维彩超来一窥它的形态:五官是否端正,四肢是否健全,心血管是否有问题等等……这都需要来一次大排畸进行检查与纠正。这关键核心的四维彩超,我们号召大家一起来找茬,让我们一起为数据库届打造一本有意义有价值有内涵的好书。

那么如何成为 《TiDB in Action》 审稿作家呢?他的职责如何定义呢?下面,我们手把手带你来审阅:

  • 选题

您可以从 github projects 中查看各大章节的状态,选择一个您感兴趣的章节,如我们对第一部分感兴趣,进入对应 project 中,即可从 TODO 列表中看到未被审核的所有章节。

  • 审稿

审稿规范的唯一标准是:逻辑清晰,浅显易懂。更多信息请参考文档说明。

  • 提交 PR

    • 如果您对 github 的提交 PR 流程并不熟悉,建议先阅读体验 手把手教你提交 Pull Request
    • 提交 PR 时,请按照 PR 描述模版填写,如下图 PR-#426 解决了 issue-#674, 作者需要在 issue 的描述中说明解决了什么 issue, 作者联系方式。那么在创建完 PR 后,就会自动关联到对应 issue 中。
    • 如果方便的话,请留下您的联系方式,方便我们联系您的同时,也方便我们后期在书中将您纳入审稿名单。
  • 合并 PR

    • 如果 PR 满足合并条件,官方会自动合并。
    • 如果有评论,需要解决掉评论所提的问题方可合并。

为了提高沟通效率,友情提示: 如果 PR 被评论一周内无状态,将被再次退回可认领状态。

互联网时代写书很简单,但是要写一本好书,就如同传道授业一般,是一个任重而道远的活。试想如果有一天,你新入职一家公司,《TiDB in Action》整整齐齐地摆放在大家桌子上,作为作者的你是否骄傲呢?如果有一天,你的孩子在玩数据库的时候,看到了爸爸妈妈的名字在历史里,又是什么感觉呢?《TiDB in Action》 不是属于一家叫 PingCAP 公司的书,它属于数据库社区,属于开源社区,属于中国技术,属于你我他,需要大家一起努力。让我们从现在开始,一起为数据库届打造一本驰名中外的好书,请开始你的表演吧:dancing_men::dancing_women::man_dancing:

7赞

优秀

secooler