js commit(JavaScript代码提交规范)

什么是js commit规范?

JavaScript代码提交规范（JS Commit）是为了使团队开发人员能够编写更简洁、可读性强、易于维护的代码，协同工作更加顺畅而制定的一种规范。该规范建立在Git的版本控制软件基础上，旨在使Git记录更加有意义、可读性更高，使得团队协作更加顺畅。

为什么需要js commit规范?

不遵循代码提交规范，会导致很多问题，如：

难以理解提交所意味的改变;

难以对提交进行分类，变更类型混乱；

不同团队成员提交commit信息风格不一，导致版本记录混乱难以维护。

有了代码提交规范，我们可以更加方便地对代码的修改进行追溯和查看。

js commit规范的编写方式

JS Commit规范共有7个组成部分，分别是：类型、作用域、简要说明、详细描述、问题修复（可选）、关联问题（可选）和独立验证（可选），其编写格式如下：

type(scope): subject

type：提交类型，用于说明提交的类别，只允许使用下面几个词：

feat：新功能（feature）

fix：修复问题（bug fix）

docs：文档（documentation）

style：格式（不影响代码运行的变动，如空格、格式化、缺少分号等）

refactor：重构（即不是新增功能，也不是修改bug的代码变动）

test：增加测试

chore：构建过程或辅助工具的变动

scope：作用域，用于说明此次修改所影响的范围。如果修改全局，可以写成 *，如果修改整个功能或每个页面都修改了，不用写这个 scope。

subject：简要说明，用于描述此次修改的主要内容。

js commit规范的实例

这里有一个实例用来说明如何使用JS Commit规范进行代码提交：

feat(search): 新增搜索栏

详细描述：

为主页添加搜索栏，方便用户查找所需内容。此次修改涉及到 HTML、CSS 和 JavaScript 三部分，具体对应了头部导航栏部分和主页部分的部分内容修改。导航栏新增“搜索”按钮和“其他”按钮，主页新增一个搜索栏，在搜索栏中输入内容后回车可以进行搜索操作。同步修改了相关的HTML和CSS代码。

js commit规范的好处

JS Commit规范可以给团队带来以下好处:

方便定位提交内容：可快速了解提交内容，解决问题时定位到相关的提交内容，提高效率；

提高代码质量：规范代码编写，避免大家轻意间写出不规范的commit信息，使代码库更加整洁，方便后续协程和维护；

提高开发效率：遵循统一的规范，可减少代码最为的沟通成本，提高开发效率。

如何实现JS Commit规范

让团队成员遵循JS commit规范需要以下几个步骤：

团队成员应该学习JS commit规范，并在改动代码之前先为自己将对该段代码的修改进行规范化的命名，以作为git commit的内容备注。

在团队流程中的代码审核阶段，其他的成员应该检查并确保git commit信息的的正确性，规范化。

将这种规范化的命名加进发起代码“pull request”的内容描述。同时也需要在github的settings里创建名为“commit message validation”的保护规则。其内容可以在Github store中找到，可以根据实际情况来进行修改。

结语

JSCommit规范对于提高开发效率和规范代码质量都十分重要。虽然第一次遵循可能会有些不习惯，但是对于团队长远发展来说，这一定是值得投入研究的。