Skip to content
No description, website, or topics provided.
JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
templates
test
.gitignore
.jscsrc
.jshintrc
.travis.yml
convention.md
index.js
package-lock.json
package.json
readme.md

readme.md

conventional-changelog可用于规范git commit message格式,自动生成项目CHANGELOG。

本项目是conventional-changelog的规范集,适配中英文写法。

提交类型

中文类型 英文类型 含义
新增 feat 新增api/功能
修复 fix 修复问题
删除 delete 删除api/参数等破坏性改动
更新 refactor 重构代码/优化代码/对代码中配置参数的变更/项目配置变化
优化 perf/chore/docs 格式优化/文档更新/优化测试等
发布 release 新的版本号/release/tag(CHANGELOG在此改动)
回滚 revert 回滚一次提交
合并 merge 合并冲突/合并PR

中文提交格式

类型[(影响范围)] 标题
// 空一行
简要说明
// 空一行
关联issue/不兼容提示

例子:

新增 xx.xxx接口

此接口用于xxxxx,传参xxx,不兼容IE8以下

close #1

如何集成到前端项目中?

安装conventional-changelog-cliconventional-changelogc-common依赖。

npm i conventional-changelog-cli conventional-changelog-common -D

如何生成changelog?

在package.json加上以下脚本(详细参数请运行npx conventional-changelog-cli --help查看):

{
    "scripts": {
        "changelog": "conventional-changelog -i CHANGELOG.md -s -r 1 -n ./node_modules/conventional-changelog-common" 
    }
}

再运行

npm run changelog

即在项目根目录生成/追加CHANGELOG.md

CHANGELOG效果如下:


0.3.30 (2018-12-19)

更新:

  • 更新 用xxx替换所有xx (d3813ff)
  • 更新 优化xxx接口参数 (055d7c1)
  • 更新 改xx.xxx()监听xxx为监听xxx (bb7a489)

修复:

  • 修复 xx和xx模块埋点覆盖冲突问题 (1894a3a)
  • 修复 在xx环境下,xx报错的问题 (e577220)

新增:


You can’t perform that action at this time.