参与贡献
Reactive Form 核心贡献者正在招募中,如有兴趣参与到源码、文档、自动化测试等工作中, 欢迎发送邮件至 lihongda@jilinxiangyun.com。
邮件标题格式为 [rcfm 参与贡献] + 姓名,邮件中请介绍个人技能情况, 也可附上个人资料链接,如 Github、LeetCode、Codepen 等。
分支管理
Reactive Form 遵循 Gitflow分支管理模型, 开发人员须以 dev 分支作为 checkout 新分支和提交 pull / merge request 的基准。
开发环境
首先,安装 asdf, asdf-ruby 和 asdf-nodejs。
接下来,切换工作目录到本地仓库根目录,执行以下操作:
- 执行
asdf install
安装项目所需的 NodeJs 版本和 Ruby版本; - 安装 yarn 1.22.10 + 和 bundler 2.2.24;
- 执行
yarn install & bundle
安装项目依赖。
脚本命令
# 启动开发环境
yarn start
# 打包源码及文档,并压缩npm tgz包和dist zip包到release目录
yarn release:build
# 以下两个测试命令应在执行过release:build后执行
# 自动执行所有测试用例
yarn release:test
# 也可手动选择测试环境执行测试用例
yarn release:test:select
# 应在release:test通过后执行
# 发布npm tgz包,dist zip包及文档
yarn release
注意事项
源码 js 打包格式分为 iife 和 esm 两种。对于 iife 格式, 需要在 scripts/injections 目录对应文件中配置 external 全局变量, 来满足 esbuild 约定的 require 方法, 详见 https://github.com/evanw/esbuild/issues/506。
主要目录
- src:Reactive Form 源码
- release: Reactive Form .tgz & .zip
- dist: Reactive Form 打包输出目录
- test: Reactive Form 测试脚本
- site:文档及站点源码
- public: 文档及站点打包输出目录
- scripts: 工程化脚本