1.0.0 • Published 4 years ago

rootzx v1.0.0

Weekly downloads
-
License
-
Repository
-
Last release
4 years ago

基于lerna和yarn workspace的monorepo工作流

相关命令

启动示例项目

$ yarn example

打包项目

打包当前平台的包:

$ yarn package

git 提交

使用下面命令代替git commit -m '':

$ yarn commit

相关技术

基于lerna和yarn workspace的monorepo工作流

lerna

lerna博客

自动changelog

eslint默认规则

单元测试覆盖率

danger

ESLint 和 Prettier

markdown

puppeteer自动截图包

git flow 分支管理

  • master分支存放所有正式发布的版本,可以作为项目历史版本记录分支,不直接提交代码。仅用于保持一个对应线上运行代码的 code base。

  • develop分支为主开发分支,一般不直接提交代码

  • feature分支为新功能分支,feature分支都是基于develop创建的,开发完成后会合并到develop分支上。同时存在多个

  • release分支基于最新develop分支创建,当新功能足够发布一个新版本(或者接近新版本发布的截止日期),从develop分支创建一个release分支作为新版本的起点,用于测试,所有的测试bug在这个分支改。测试完成后合并到master并打上版本号,同时也合并到develop,更新最新开发分支。(一旦打了release分支之后不要从develop分支上合并新的改动到release分支),同一时间只有1个,生命周期很短,只是为了发布。

  • hotfix分支基于master分支创建,对线上版本的bug进行修复,完成后直接合并到master分支和develop分支,如果当前还有新功能release分支,也同步到release分支上。同一时间只有1个,生命周期较短

packages下文件规范

文件夹命名规范:

采用 包类型-包名称方式命名,包类型有一下几种

  • block 区块类包(用户可下载放入项目中修改后使用)

  • layout 布局类包(用户可下载放入项目中修改后使用)

  • comonent 业务组件(用户安装后引用后使用,不可以修改,需要提供文档和api说明)

    如:

    block-operation-notice 
    
    layout-operation

package.json中name字段命名规范:

采用 @artworks/文件夹名称

@artworks/ 后面名字跟文件名保持一致

package.json中script字段命名规范:

  • build命令 打包组件、区块、布局成一个可预览的静态页面

  • start命令 预览打包后的静态页面

  • build:es命令 业务组件打包成可发布的格式

其他

版本号语义化规范

目录说明