VIS-THREE 贡献指南

欢迎阅读 vis-three 贡献指南。

项目管理说明

• 本项目使用的是pnpm进行项目开发管理，pnpm 文档：https://www.pnpm.cn/
• 安装依赖：在项目根目录执行：pnpm i

项目结构

• /docs为本项目的在线静态站点。需要通过website更新。
• /packages/docs为文档仓库。执行pnpm run build会自动更新到website目录。
• /packages/examples为例子仓库。执行pnpm run build会自动更新到website目录。
• /packages/website为静态页面仓库。执行pnpm run build后会更新在线静态站点。
• /packages/create-vis-three为快速构建模块包的命令工具。
• /packages/core为核心仓库。
• /packages/middleware为配置化核心仓库。
• /packages/plugins为官方提供的插件文件夹。
• /packages/strategy为官方提供的策略文件夹。
• /packages/packages/engine为官方提供的预置引擎文件夹。
• /packages/library为官方提供的颜色库文件夹。
• /packages/convenient为官方提供的便利工具仓库。
• /packages/utils为官方提供的工具库。
• /packages/test为官方的测试模块，在这里会对所有模板进行单元测试和 e2e 测试。

模块包更新

由于本项目使用的是monorepo模式，再搭配pnpm进行仓库管理，在进行开发时需要注意更新流程与事项。

代码更新

当我们在进行模块修改时，可以通过/packages/examples模块，实时修改验证内容，并且顺便提供演示例子。

修改完成后确认无重大 bug，需要在当前模块包内执行pnpm run build打包。

版本修改

打包完成之后，我们需要对比 npm 版本进行package.json的版本更新，比如:

• @vis-three/core的在线 npm 版本号为：0.6.0
• 查看@vis-three/core的package.json文件的version字段，如果是0.6.0那么就要将其最后一个数字加一 -> 0.6.1(只修改小版本)。如果已经是修改过的，就不用管。

全局更新版本依赖

当我们修改了一个模块版本之后，我们需要同步其他的模块对此模块的依赖为最新版本，这个时候我们去到项目根目录，执行pnpm up @vis-three/* -r它会将所有相关依赖更新到最新。

测试

包发版