DEVELOP.md

开发注意事项

changelog

lerna-changelog基于pr来为项目生成changelog

使用步骤

1、从master分支切换出feature/bugfix等分支。
2、完成开发后进行commit，推荐使用commitizen来规范commit msg，同时有助于对后续子项目生成changelog。
3、将新分支push到remote端。
4、创建pr，并打上label，此处一定要打上label，learn-changelog就是根据 label 来确定该pr属于feature/bugfix/document等。
5、切记要在merge之前打上label。
6、进行merge pr操作。 7、本地切换到master分支并进行pull操作。
8、执行lerna-changelog，既可得到一份changeling。

注意

1、pr的label并不能随意设置，一定要在项目中声明对应才生效。
官方默认支持breaking/enhancement/bug/documentation/internal，如果想用其他，则需要在 package.json 中进行相应的配置。

{
  "changelog": {
    "labels": {
      "feat": ":rocket: New Feature",
      "bug": ":bug: Bug Fix",
      "doc": ":memo: Documentation",
      "internal": ":house: Internal",
      "breaking": ":boom: Breaking Change"
    }
  }
}

2、src/version 在 publish 时自动更新版本号，不需要手动修改。发布后不需要签入。

子项目的 changelog

具体还需参考README