mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-07-14 23:21:29 +08:00
docs: 补充新增修改代码测试覆盖率不低于85%的开发约定
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
parent
42d45bed18
commit
f7d737a0c0
10
AGENTS.md
10
AGENTS.md
@ -14,12 +14,13 @@ TMagic Editor 是魔方平台的可视化编辑器核心库,提供拖拽式组
|
|||||||
## 架构地图
|
## 架构地图
|
||||||
|
|
||||||
关键目录:
|
关键目录:
|
||||||
- `packages/` — 核心编辑器包(202 *.vue, 194 *.ts)
|
|
||||||
|
- `packages/` — 核心编辑器包
|
||||||
- `runtime/` — Vue/React Runtime 实现
|
- `runtime/` — Vue/React Runtime 实现
|
||||||
- `vue-components/` — Vue 组件封装
|
- `vue-components/` — Vue 组件封装
|
||||||
- `react-components/` — React 组件封装
|
- `react-components/` — React 组件封装
|
||||||
- `playground/` — 演示 playground
|
- `playground/` — 演示 playground
|
||||||
- `docs/` — VitePress 文档(100 *.md)
|
- `docs/` — VitePress 文档
|
||||||
- `scripts/` — 构建和发布脚本
|
- `scripts/` — 构建和发布脚本
|
||||||
- `eslint-config/` — 共享 ESLint 配置
|
- `eslint-config/` — 共享 ESLint 配置
|
||||||
|
|
||||||
@ -27,10 +28,13 @@ TMagic Editor 是魔方平台的可视化编辑器核心库,提供拖拽式组
|
|||||||
|
|
||||||
**分支策略:** dev=dev, test/prod=master
|
**分支策略:** dev=dev, test/prod=master
|
||||||
**提交规范:** commitlint + husky,`type: 描述`
|
**提交规范:** commitlint + husky,`type: 描述`
|
||||||
|
**测试覆盖率:** 新增或修改的代码必须补充单元测试,覆盖率不低于 85%
|
||||||
|
|
||||||
**禁止事项:**
|
**禁止事项:**
|
||||||
|
|
||||||
- 禁止在核心包中引入腾讯内部专有依赖(开源项目)
|
- 禁止在核心包中引入腾讯内部专有依赖(开源项目)
|
||||||
- 禁止直接修改 CHANGELOG.md,应通过 `pnpm changelog` 生成
|
- 禁止直接修改 CHANGELOG.md,应通过 `pnpm changelog` 生成
|
||||||
|
- 禁止提交未达 85% 测试覆盖率的新增/修改代码
|
||||||
|
|
||||||
## 常用命令
|
## 常用命令
|
||||||
|
|
||||||
@ -50,7 +54,7 @@ TMagic Editor 是魔方平台的可视化编辑器核心库,提供拖拽式组
|
|||||||
## 深入阅读
|
## 深入阅读
|
||||||
|
|
||||||
| 文档 | 说明 |
|
| 文档 | 说明 |
|
||||||
|------|------|
|
| --------------- | ---------------- |
|
||||||
| docs/ | VitePress 文档站 |
|
| docs/ | VitePress 文档站 |
|
||||||
| CONTRIBUTING.md | 贡献指南 |
|
| CONTRIBUTING.md | 贡献指南 |
|
||||||
| CHANGELOG.md | 变更日志 |
|
| CHANGELOG.md | 变更日志 |
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user