定义编码规范,并通过预提交钩子来强制执行这些规范,这样非常有助于写出具有可维护性的代码。只要遵循这些规范,不管是谁写的代码,它们看起来都具备了同样的风格,其他人在接手或维护这些代码时会更加省事。
我推荐使用Prettier和StandardJS,不过还有很多其他的选择,具体根据自己的情况而定。
typicode/husky是一个很好的预提交钩子配置工具,项目地址https://github.com/typicode/husky。
7.为PR配置自动化测试
对PR进行自动化功能测试、安全检查和代码风格检查是非常有必要的,但不应该通过手动的方式做。每当有PR提交时,持续集成服务器(如TravisCI)可以在相应的branch上自动执行测试,这样可以防止开发者将未通过测试的PR提交到GitHub上。如果测试失败,GitHub会在PR中显示一条消息,让提交者尽快修复问题。
TravisCI文档https://docs.travis-ci.com/user/pull-requests。
8.保护好master,进行代码评审
GitHub为保护master提供了可能性,避免代码直接提交到master上,或对其进行rebase。当多人合作开发一个项目时,这点是非常重要的。另外,在将代码合并到master时,将代码评审作为必要的步骤。这个可以在每个代码库的settings页面进行配置。
保护好master,并强制执行代码评审,你就可以高枕无忧,无需担心糟糕的代码会被合并到master上,也不会有人提交未经评审的代码。
9.squash你的PR
关于该使用merge、squash还是rebase存在很大的争议,不过我认为最好是使用squash,因为:
不是所有的开发者都知道如何进行rebase,大部分开发者都只是简单地在他们的变更之上合并master。squash避免了无用的合并信息和往git日志中添加噪音。
不是所有的开发者都会遵循提交规范,squash有助于控制合并到master上的提交信息。
为了更好地进行squash,每个PR都应该属于某个特定的功能、bug修复或任务。
10.版本语义、标签、发布和自动化变更日志
版本管理对于软件来说非常重要,特别是在开源软件中,有很多其他项目可能会依赖你的项目。有了版本语义,我们通过版本号就可以知道某个版本是否包含了突破性变更,或者版本是否包含了新特性或bug修复。
版本格式通常是这样的MAJOR.MINOR.PATCH:
在做出不兼容的API变更时,增大MAJOR。
增加向后兼容的新特性时,增大MINOR。
进行向后兼容的bug修复时,增大PATCH。
我们还可以对这个格式进行扩展,加入额外的标签,作为预发布版本和构建元数据。
Conventional Commits规范(https://conventionalcommits.org)建议基于提交消息引入一种轻量级的规范,与SemVer一起使用,让开发者在提交消息中提供与功能、bug修复和突破性变更相关的描述。
TravisCI有助于自动化这一过程https://docs.travis-ci.com/user/deployment/releases。
11.使用标签钩子进行自动化部署
GitFlow建议使用release分支进行发布,但这不是必需的。我们可以通过git标签获取要部署的文件,TravisCI的文档(https://docs.travis-ci.com/user/deployment/heroku)介绍了如何将git标签部署到heroku上。其实很简单,只需要将标签属性设置为true就可以了。其他CI服务器的配置也类似。
我们可以在开发环境配置钩子,用于部署最新的master代码。我们也可以为每个PR创建临时的测试环境,不过这样做非常复杂,所以不一定要这么做。
12.建立GitHub流式通道
这是一种非常方便的跟踪GitHub活动的方式,可以通过这种方式与其他人进行协作沟通。每个GitHub聊天室都会有通知流,GitHub在2013年为此发明了一个新术语,叫作ChatOps。
13.自动化依赖更新
保持依赖更新是一项非常耗时的重复性工作,所以可以将它自动化。所幸的是,有很多工具可用于保持依赖更新,它们会基于项目的最新版本创建PR,然后自动执行非回归测试,如果测试通过,那么在合并PR后这些代码依然能够正常运行。不过如果有主版本变化,需要进行双重检查。
可以参考这两个工具:https://greenkeeper.io和https://david-dm.org。
14.使用扩展来提升GitHub的UI体验