hqcontact v1.0.10

hq library 模板

开发基本规范

pull request方式提交 code review方式介绍

简单可行的code review 规则

节选: checkList

常规项

• 代码能够工作么？它有没有实现预期的功能，逻辑是否正确等。
• 所有的代码是否简单易懂？
• 代码符合你所遵循的编程规范么？这通常包括大括号的位置，变量名和函数名，行的长度，缩进，格式和注释。
• 是否存在多余的或是重复的代码？
• 代码是否尽可能的模块化了？
• 是否有可以被替换的全局变量？
• 是否有被注释掉的代码？
• 循环是否设置了长度和正确的终止条件？
• 是否有可以被库函数替代的代码？
• 是否有可以删除的日志或调试代码？

git commit 提交规范

节选: Commit message格式

<type>: <subject>

注意冒号后面有空格。

type

用于说明 commit 的类别，只允许使用下面7个标识。

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

如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。

subject

subject是 commit 目的的简短描述，不超过50个字符，且结尾不加句号（.）。

lib 注意事项

• 一个版本发布后, 版本号和此时代码锁定, 再有更新, 需要升级版本号
• lib是所有项目的基础, 对于代码质量要求严格, 必须经过充分自测后才能发布

项目简介

xxx

文档配置参照

dumi

Getting Started

Install dependencies,

$ pnpm install

Start the dev server,

$ npm start

Build documentation,

$ npm run docs:build

Build library via father-build,

$ npm run build

Run Test

$ npm run test

lerna 发包

常用命令

发布正式版

cd packages/myproject

lerna publish patch

patch可以根据情况替换

• major 主版本 版本号第一位
• minor 次版本 第二位
• patch 补丁版 第三位

发布测试版

cd packages/myproject

lerna publish prerelease

prelease可以根据情况替换

• premajor
• preminor
• prepatch
• prerelease

更多参数文档见lerna