1.1 KiB
1.1 KiB
role-admin 协作规则
基本约定
- 使用
pnpm,不要引入npm、yarn或bun锁文件。 - 业务接口统一放在
src/api/access.ts,页面层不要直接拼接后端 URL。 - 权限管理菜单集中在
src/router/modules/employees.ts,默认标签页入口集中在src/layout/types.ts。 - 页面注释只解释业务边界、接口契约、状态流转和容易误改的模板机制,不做机械逐行注释。
README 同步要求
- 只要新增、删除、移动目录或关键入口文件,就必须同步更新
README.md的「目录说明」。 - 只要新增、删除、重命名
package.json中的关键脚本,就必须同步更新README.md的「重要脚本」。 - 只要新增业务模块、接口模块、路由模块或环境配置,就必须同步更新
README.md的对应说明。 - 如果一次任务只触达局部文件,也要至少补齐当前任务相关的 README 内容;大范围遗留问题需要在交付说明里明确。
验证
- 文档或注释改动至少执行
pnpm typecheck。 - 涉及源码、路由、构建配置或依赖脚本时,同时执行
pnpm build。