npm 包 @talentui/commit-types 使用教程

阅读时长 5 分钟读完

什么是@talentui/commit-types?

@talentui/commit-types 是一个 npm 包,它提供了一种命名约定,用于规范化 Git 提交信息的格式,以便于其他开发人员更好地了解提交的意义和目的。它采用了约定式提交的规范,其中包含了一系列预定义的提交类型,如 featfixdocs 等。

为什么要使用@talentui/commit-types?

完整清晰的 Git 提交信息可以帮助其他开发人员更好地了解当前的开发进程,有效的提高团队的协作效率。而 @talentui/commit-types 提供了一套针对代码贡献的约定,使提交信息的格式更具有清晰性和可读性。

同时,在使用 @talentui/commit-types 时还可以进行一些自定义配置,根据团队的开发需求和规范进行个性化的提交类型分类和配置,从而提高开发工作效率。

如何安装?

可以通过以下命令来安装@talentui/commit-types:

如何使用?

在初始化 Git 仓库后,需要做以下操作:

  1. 在项目根目录创建 .cz-config.js 文件,内容如下:
-- -------------------- ---- -------
-------------- - -
  -------- -
    --------- ------- ------- ------     ------
    --------- ------ ------- -----      --- -----
    --------- ------- ------- ------     -------
    --------- -------- ------- -------    ------ ----- - -------------
    --------- ----------- ------- ---------- -------
    --------- ------- ------- ------     -------
    --------- ------- ------- ------     ------------
    --------- -------- ------- -------    ------------------
    --------- --------- ------- --------   -------
    --------- ------ ------- -----      -------
  --
  ----------- -
    ------- --------------
    -------- ---------- -------
    ---------- -------
    ------- -----------------------
    ----------- ------- ---------
    --------- ------------------ ------------
    ---------------- ---------
  --
  -------------------- -----
  --------------- ---
--
  1. 在 package.json 中添加以下代码:
  1. 运行 npm run commit 命令来提交代码,可以选择提交类型、作用域、短说明、长说明、非兼容性说明以及关闭的 issues 等。

示例代码

以下代码演示了如何在 React 中使用 @talentui/commit-types:

-- -------------------- ---- -------
------ ------ - --------- - ---- --------
------ - ------ - ---- -------
------ --------- ---- -------------

----- -------- ------- --------- -
  ------ --------- - -
    ----- -----------------
    ----- --------------------------- -------- ----------
    -------- --------------
  --

  ------ ------------ - -
    ----- ----------
    ----- ----------
    -------- -- -- --
  --

  ----------- - -- -- -
    ----- - ------- - - -----------
    ----------
  --

  -------- -
    ----- - ----- ---- - - -----------

    ------ -
      ------- ----------- ----------- ---------------------------
        ----- ---
      ---------
    --
  -
-

------ ------- ---------

在你的新功能提交信息中,应该这样描述你的代码更改:

在 Bug 修复提交信息中应该这样描述你的代码更改:

在文档变更提交信息中应该这样描述你的代码更改:

等等。这样使用 @talentui/commit-types 可以大大提高代码编写和协作的效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/99925