20 lines
1.5 KiB
Markdown
20 lines
1.5 KiB
Markdown
# 项目协作规范
|
|
|
|
## 默认分支与工作目录
|
|
|
|
- 新增功能、新增文件、修复问题和重构,默认全部在本项目根目录的 `dev` 分支进行。
|
|
- 开始修改前先确认当前分支。若不在 `dev`,应保留现有修改并安全切换到 `dev`,不得丢弃或覆盖用户已有工作。
|
|
- 不创建新的 Git worktree,不在 `worktree`、`worktrees`、`.worktree` 或 `.worktrees` 目录中新增或修改文件。
|
|
- 不因技能、模板或默认隔离流程而创建工作树;本规则覆盖此前“新功能在 worktree 中开发”的项目约定。
|
|
- 已有工作树仅在用户要求迁回改动时作为只读来源;迁回后在项目根目录的 `dev` 分支继续修改和验证。
|
|
- 未经用户明确要求,不提交代码、不推送、不切换或合并到其他发布分支。
|
|
|
|
## 开发与验证
|
|
|
|
- 尽量使用中文沟通,沿用项目现有的 Vue 3、TypeScript、Tailwind CSS 和 pnpm 约定。
|
|
- 新增或修改的函数、类型、响应式状态及页面模块需要中文注释;函数有参数或返回值时补充 `@param`、`@returns`。
|
|
- 超过两个位置使用的相同功能或组件,应抽成公共方法或组件。
|
|
- 页面和交互验证使用本地 Chrome,地址使用 `localhost`,禁止使用 Playwright;已有对应测试标签页时复用它。
|
|
- 以真实接口和后端契约为准,不用占位数据或其他功能代替缺失能力。
|
|
- 提交代码时遵循项目的 Conventional Commits 规范,使用中文描述;提交前先检查实际差异。
|