开发流程与代码规范

November 1, 2018 · View on GitHub

开发流程

仓库

托管在码云私有仓库上， see: https://gitee.com/

分支管理

git 分支管理规范

提交流程

参见教程: http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

git add YOUR_EDITED_FILES
git cz
git push

安装 commitizen

commitizen, 可以实现提交提示可视化， see: https://github.com/commitizen/cz-cli
提交内容主要分为以下几个方面

feat：新功能（ feature ）
fix：修补bug
docs：文档（ documentation ）
style： 格式（ 不影响代码运行的变动 ）
refactor：重构（ 即不是新增功能，也不是修改bug的代码变动 ）
test：增加测试
chore：构建过程或辅助工具的变动
build: 与构建工具相关的更改

 npm install -g commitizen
 commitizen init cz-conventional-changelog --save --save-exact

standard-version

使用 standard-version 生成 changelog see: https://github.com/conventional-changelog/standard-version

commitlint

基于 commitlint 验证 git message 是否规范
see: https://github.com/marionebl/commitlint

本脚手架使用 angular 规则，详情参见:
https://github.com/marionebl/commitlint/tree/master/@commitlint/config-angular

npm install @commitlint/cli --save-dev
npm install @commitlint/config-angular --save-dev

代码规范

业界参考

JavaScript 代码规范, 参见业界公认的 airbnb 规范: https://github.com/airbnb/javascript
Angular 规范，直接参考官网: https://angular.io/guide/styleguide , 默认已集成部分检测工具，如 tslint-angular，手动检测可以执行命令 npm run lint