0.7.33 • Published 3 years ago

cjd-parkball v0.7.33

Weekly downloads
-
License
ISC
Repository
-
Last release
3 years ago

Parkball

中后台业务组件库,中后台就像公园,进入需要买门票(登录),所以以 Parkball(公园球) 命名,公园内必定捕获!作为一个组件库,提供使用方法文档,方便开发者的调用

使用方法

//以本地开发服务器运行parkball
npm run dev
//编译文档到publish文件夹
npm run build
//发包,请用以下命令,不要直接 npm publish
npm run package

规范

流程规范

增加新组件开分支 feature/{new-component}

既有组件修复 bug 开分支 hotfix/{component}

已有组件增加新功能开分支 feature/{component-feature}

组件规范

  • 组件文件夹以平级展开,所有组件地位一致
  • 组件命名需要规范化、通用化, 参考以下地址 这个控件叫什么ant design设计系统「规范文档」编写指南 · 第二篇 - 组件简介,杜绝无意义的命名 如table1, table2
  • 组件内建议拆分细粒度组件,所有入参需要加校验,建议 ts 编写,加强类型校验及 ide 友好体验
  • 组件开发需要编写四部分内容,组件需求描述、可运行的组件、测试用例及文档 demo

文档规范

关于文档规范,请参照doc目录下的README.md

发布规范

发版前,一定要写好 docs/changelog.md 当前版本的变化内容

changelog 格式

### ${version}(${release date})
1. version change content
2. version change content
3. version change content