mirror of
https://github.com/Powerful-517/yys-editor.git
synced 2026-03-05 15:05:27 +00:00
rookie4show
92aa4094f5
- 安装 vitest, @vue/test-utils, jsdom 等测试依赖 - 配置 vitest.config.js 测试环境 - 添加 schema.test.ts (7个数据结构验证测试) - 添加 useStore.test.ts (7个状态管理测试) - 创建测试指南文档 (docs/testing.md) - 创建测试规范文档 (docs/testing-rules.md) - 创建开发规范文档 (docs/development-rules.md) - 创建开发工作流程文档 (docs/1management/workflow.md) - 添加测试相关 npm scripts (test, test:watch, test:ui, test:coverage) - 所有测试通过 (14/14)
79 lines
1.7 KiB
Markdown
79 lines
1.7 KiB
Markdown
# yys-editor 项目规范
|
|
|
|
## 代码提交规范
|
|
|
|
### 必须遵守的规则
|
|
|
|
1. **测试优先原则**
|
|
- 所有涉及数据层和业务逻辑的改动，必须先编写或更新测试用例
|
|
- 提交前必须运行 `npm test` 确保所有测试通过
|
|
- 详见 [测试规范](./testing-rules.md)
|
|
|
|
2. **代码格式化**
|
|
- 提交前运行 `npm run format` 格式化代码
|
|
- 使用 Prettier 统一代码风格
|
|
|
|
3. **代码检查**
|
|
- 提交前运行 `npm run lint` 检查代码质量
|
|
- 修复所有 ESLint 警告和错误
|
|
|
|
## 开发工作流
|
|
|
|
```
|
|
需求分析 → 编写测试 → 实现功能 → 测试通过 → 格式化 → Lint → 提交
|
|
```
|
|
|
|
## 快速检查命令
|
|
|
|
```bash
|
|
# 一键检查（推荐在提交前运行）
|
|
npm test && npm run lint && npm run format
|
|
```
|
|
|
|
## 分支管理
|
|
|
|
- `main` - 主分支，保持稳定
|
|
- `dev` - 开发分支
|
|
- `feature/*` - 功能分支
|
|
- `fix/*` - 修复分支
|
|
|
|
## Commit 消息规范
|
|
|
|
```
|
|
<type>: <subject>
|
|
|
|
<body>
|
|
```
|
|
|
|
### Type 类型
|
|
- `feat`: 新功能
|
|
- `fix`: 修复 bug
|
|
- `test`: 添加或修改测试
|
|
- `refactor`: 重构代码
|
|
- `style`: 样式调整
|
|
- `docs`: 文档更新
|
|
- `chore`: 构建或工具变动
|
|
|
|
### 示例
|
|
```
|
|
feat: 添加式神数据导入功能
|
|
|
|
- 实现 JSON 格式导入
|
|
- 添加数据验证逻辑
|
|
- 补充单元测试
|
|
```
|
|
|
|
## 代码审查要点
|
|
|
|
1. 是否有对应的测试用例
|
|
2. 测试是否全部通过
|
|
3. 代码是否符合项目风格
|
|
4. 是否有明显的性能问题
|
|
5. 是否有安全隐患
|
|
|
|
## 相关文档
|
|
|
|
- [测试指南](./testing.md) - 如何运行和编写测试
|
|
- [测试规范](./testing-rules.md) - 测试相关的强制要求
|
|
- [项目结构](../docs/1management/plan.md) - 项目整体架构
|