- 统一使用
pnpm,禁止使用npm或yarn。 - 首次安装依赖:
pnpm install - 新增依赖:
pnpm add <pkg>/pnpm add -D <pkg> - 删除依赖:
pnpm remove <pkg> - 提交前应确保
pnpm-lock.yaml与package.json一致。
- Node 与依赖管理:
- 使用
package.json中声明的packageManager版本(通过 Corepack 管理)。 - 不手动编辑
dist/产物,源码修改应在src/与static/下进行。
- 使用
- 日常开发流程:
- 启动开发:
pnpm run dev - 类型构建检查:
pnpm run build - 代码检查:
pnpm run lint - 自动格式化:
pnpm run format
- 启动开发:
- 提交前最小检查:
pnpm run lintpnpm run buildpnpm run format
- 变更原则:
- 单次提交聚焦一个主题,避免混入无关改动。
- 修改行为时,需同步更新
README.md(如运行方式、接口、配置变化)。
- 提交信息格式:
<type>(<scope>): <subject>
type建议值:feat新功能fix缺陷修复refactor重构(不改变外部行为)perf性能优化docs文档变更style纯样式/格式调整(不改逻辑)test测试相关chore杂项维护(构建、工具、依赖等)ciCI/CD 配置变更revert回滚提交
- 书写要求:
subject使用祈使句,简洁明确,英语,首字母小写,不超过 72 个字符。- 需要补充背景时,在正文说明
why与影响范围。 - 破坏性变更需在正文或页脚标注
BREAKING CHANGE:。
示例:
feat(replay): support ops-v1 binary patch stream
fix(auth): invalidate previous session on re-login
docs(readme): replace npm commands with pnpm
chore(deps): migrate lockfile to pnpm-lock.yaml