背景: - 管理中心侧栏菜单名为「用户与组织」,与「角色管理」「部门管理」的命名方式不一致; - 页面标题、面包屑仍沿用旧名,三处展示不统一; - A1 文档与代码注释中该功能域本来即称「用户管理」。 改动: - nav-config:菜单 label 改为「用户管理」,description 改为「成员账号、部门归属与登录状态」; - breadcrumbs:用户新建 / 详情子路由的面包屑 2 处同步; - UsersPage:页面 h1 同步; - nav-config.spec / breadcrumbs.spec / e2e a1-identity 的标签与 heading 断言同步; - 11-前端路由与目录规范、AppLayout 注释同步;PRD P-01 功能名保持「用户与组织管理」不变。 影响面: - 仅前端文案与对应断言;路由、权限点、接口、数据均不变。 回滚方式: - 回滚本提交即恢复原「用户与组织」文案与断言。 验证证据: - pnpm format:check / lint / typecheck 通过; - pnpm test:web 120/120 通过; - Chrome 1440×900 实机:侧栏、面包屑、页面标题均显示「用户管理」。
工程规范索引
本目录是
AGENTS.md的下游细则。总纲只写红线与索引,细则在这里展开。 阅读顺序:先读总纲 §3 硬红线,再按任务查对应细则。
| 编号 | 文档 | 覆盖范围 | 强制级别 |
|---|---|---|---|
| 01 | Git 规范 | main 直推、提交信息、推送与发布、Tag、大文件 | 强制 |
| 02 | 代码风格 | 命名、类型、错误处理、异步、React、注释、导入顺序 | 强制 |
| 03 | 格式化与 Lint | Prettier / ESLint 配置、钩子、CI 门禁、豁免流程 | 强制 |
| 04 | API 与路由规范 | REST、版本、错误码、鉴权链、任务协议、上传下载、前端路由 | 强制 |
| 05 | 数据库规范 | 命名、主键、客户隔离、索引、迁移、事务、保留期 | 强制 |
| 06 | 测试与 CI 规范 | 分层测试、必测清单、门禁、发布与回滚 | 强制 |
| 07 | Code Review 规范 | 提交说明、双人场景、Review 清单、DoD | 强制 |
| 08 | 日志与可观测性规范 | 日志字段、trace、审计、指标、告警 | 强制 |
| 09 | 环境变量与密钥规范 | env 命名、校验、密钥管理、轮换、泄露处置 | 强制 |
| 10 | 资产命名与 PSD 图层规范 | 资产归属、命名占位符、图层前缀、规格矩阵、低质量标记 | 强制 |
| 11 | 前端路由与目录规范 | 模块/路径表、路由语法、目录映射、旧链重定向、新增页面检查清单 | 强制 |
规范文档自身的约定
| 项 | 约定 |
|---|---|
| 编写语言 | 中文说明 + 英文标识符 / 命令 / 路径;Git 提交信息也用中文(见 01 §2) |
| 结构 | 作用与边界 → 规则(表格 / 编号)→ 检查清单 → 违规示例 |
| 变更 | 修改规则须单独提交,说明「为什么改」+「存量代码如何处理」 |
| 版本 | V<主>.<次>;主版本 = 破坏性(存量代码需整改),次版本 = 补充 |
| 冲突 | 与本目录细则冲突时以技术架构为准;技术架构未覆盖以 PRD 为准 |
| 有效性 | 规则必须可被检查(lint / CI / review 清单 / 脚本),否则降为「建议」 |
| 废止 | 删除规则必须在提交说明里写清理计划,禁止直接删条目 |
与总纲的关系
- 总纲
AGENTS.md§3 的 14 条硬红线不得在本目录被弱化,只能细化。 - 本目录新增的「强制」规则,须在总纲 §9 索引同步登记。
- 规则编号规则:
<文档号>-<序号>,如DB-07、API-03,便于代码注释与 Review 引用。
当前状态说明(2026-11-02)
仓库处于文档阶段,尚无代码。本目录是建仓前置规范:代码落地时必须按此执行,不允许「先写代码、后补规范」。
待代码落地后需要补充/校准的配置类文件(届时以实际配置为准,规范条目不变):
.editorconfig · .nvmrc · .npmrc · prettier.config.mjs · eslint.config.mjs · commitlint.config.js · .lintstagedrc · turbo.json · docker-compose.dev.yaml · .env.example