@alimaretail/ma-rax-materials
一个面向移动端的跨端多包组件库
分支规范
- 主分支
master
, 每次发 npm 包之后需要合并到master
分支 - 每次开始迭代开发, 从
master
分支拉迭代分支daily/x.y.z
, 一般就 z、y 慢慢涨就行 - 每次开发功能时, 从
daily/x.y.z
拉feature/componentName
功能开发分支 - 功能开发完成后, 从
feature/componentName
提 MR 到daily/x.y.z
分支, 找其他同学做合并, 并删除源分支 - 需要发包时, 需在群里同步到其他同学一起上车发包, 维护
CHANGELOG.md
, 在daily/x.y.z
上执行fie npm publish
- npm 包发布成功后, 手动打个
publish/x.y.z
的 tag, 将daily/x.y.z
提 MR 到master
分支, 找其他同学做合并, 并删除源分支
编码规范
ts 规范
- 不允许使用 any
- 组件需要有默认值
- 不同场景需要在文档中体现
css 规范
- 最外层样式命名
rm-component-name
, 比如rm-bottom-button
, 已经在core/global.scss
中定义了前缀变量, 可以直接使用 - 其他样式必须在最外层包裹下
- 一般尺寸使用
rpx
或者vw/vh
- 跟随主题切换的需要用变量
@import '../core/index.scss';
.#{$class-prefix}-component-name {
}
css token规范
- 开放Token命名
--rm-${组件名}-{开放位置}-{样式名}
- 需要有默认样式
--bm-shop-header-text-color: var(--color-brand-3, #ff6a00);
调试
启动调试
fie start <componentName> [demoName]
构建
fie build
同步物料到物料中心
fie sync -e prod