#开发流程

#启动项目

1pnpm install && pnpm dev

#理解需求并编写代码

这是一个复杂的过程, 但一般情况, 就是三件事情:

1. 明确输入, vseed
2. 明确输出, vseed 转为 advancedVSeed, 或 advancedVSeed 转为 spec
3. 编写代码, 确保新的输入有符合预期的输出

#新建测试用例

若有必要, 则可以考虑新建测试用例

在packages/vseed/tests/*目录下, 新建一个testName.json, 并写入vseed DSL.

执行

1pnpm build:canvasTest

#执行单元测试并更新覆盖率

1pnpm test:coverage

确保3件事情

1. 所有的测试都通过
2. 快照变动都符合预期
3. 覆盖率没有下降

覆盖率变化情况, 会自动更新至README.md

#更新配置项文档

如果修改了图表类型的Typescript定义, 请更新配置项文档.

1pnpm build:docs

#发布与提交

1pnpm changeset

执行 pnpm changeset 命令后会，根据提示选择进行以下操作

1. 选择需要变化的包, 一般情况下, 只有vseed
2. 遵循语义化版本, 选择变更类型, 绝大多数情况, 连续2次回车键, 跳过 major 和 minor 后, 选择 patch 即可.
3. 输入变更描述, 例如: fix: chart render error caused by only one measure

#提交

1git add .
2git commit -m "fix: chart render error caused by only one measure"
3git push