开发流程
启动项目
启动项目
理解需求并编写代码
这是一个复杂的过程, 但一般情况, 就是三件事情:
- 明确输入,
vseed - 明确输出,
vseed转为advancedVSeed, 或advancedVSeed转为spec - 编写代码, 确保新的输入有符合预期的输出
Tip
playground(apps/website/docs/zh-CN/playground/index.mdx), 可以进行调试与开发.
新建测试用例
若有必要, 则可以考虑新建测试用例
Tip
覆盖率降低时, 则需要新建测试用例
在packages/vseed/tests/*目录下, 新建一个testName.json, 并写入vseed DSL.
执行
创建测试用例
执行单元测试并更新覆盖率
执行单元测试并更新覆盖率
确保3件事情
- 所有的测试都通过
- 快照变动都符合预期
- 覆盖率没有下降
覆盖率变化情况, 会自动更新至README.md
更新配置项文档
如果修改了图表类型的Typescript定义, 请更新配置项文档.
Tip
packages/vseed/src/types/chartType 下的所有类型定义, 对应着每一个图表的配置项文档, 如有变化, 请务必更新
更新配置项文档
发布与提交
描述变更内容
执行 pnpm changeset 命令后会,根据提示选择进行以下操作
- 选择需要变化的包, 一般情况下, 只有vseed
- 遵循语义化版本, 选择变更类型, 绝大多数情况, 连续2次回车键, 跳过
major和minor后, 选择patch即可. - 输入变更描述, 例如:
fix: chart render error caused by only one measure
建议
一个功能或Bugfix, 对应一个changeset, 对应一个commit
一个 Pull Request, 对应 一个issue
一个 Pull Request, 对应多个功能或多个Bugfix, 对应多个changeset, 对应多个commit
提交
提交所有内容