Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

55 lines (39 loc) · 1.55 KB

如何开发

  1. 项目使用 lerna 管理,所有的大包在/packages,所有的自定义组件包在/widgets
  2. 如何跑起来(以下操作全在根目录)
# 安装依赖,请使用yarn,会去重的安装所有node_modules
yarn
# 首次开发需要 build 一下,否则有些仓库的import在dumi里会找不到
npm run build
# 将文档网站跑起来
npm start
  1. 进入文档网站了,如何开发呢?

例如要开发 form-render 在 /docs/form-render/guide 目录下写一个 test.md 文件, 参考 /docs/form-render/guide/new-feature.md 的写法即可。发布前把 test.md 干掉,或者放到不会被展示的文件目录下

  1. 重新安装依赖
# 先清空
npm run clean
# 再安装
yarn

注意 lerna clean 不会清除顶层的 node_modules,所以如果因为特殊原因要彻底清空依赖,请执行rm -rf node_modules

  1. 发布

在顶层执行

npm publish

会进入交互对话,所有被改动过的仓库都会提示你是否要发布,以及版本

或者我其实更推荐,进入相应项目的文件夹,例如 form-render

# 进入
cd packages/form-render
# 换版本号、打tag。注意tag要打,便于release note的维护
yarn version --new-version 1.1.0
# 发布
npm publish

发布后记得到 releases 页 补上最新的 release 信息

  1. 分支管理

外部同学请 fork,内部同学请在 dev 分支开发,然后都发 pull-request 到 master 分支,由负责同学审核后合并,master 分支请勿人为去动