docs: 豁免设计系统 token 的命名约束（R10）

2026-09-10 10:22:21 +08:00
parent ac9019d56a
commit bf983833c8
1 changed files with 5 additions and 1 deletions
@@ -19,7 +19,11 @@
 - **依赖约束**：阶段一**不引入** Hilt、Room、Retrofit、第三方图表库。图表一律用 Compose `Canvas` 手绘。
 - **不硬编码文案**：所有用户可见文字进 `res/values/strings.xml`（默认中文）。
 - **禁止行内样式散落**：颜色/字号统一定义在 `core/designsystem/`，页面不得直接写 `Color(0xFF...)`。
- **命名规范**：类/Composable 用 PascalCase；函数/变量用 camelCase；常量用 UPPER_SNAKE_CASE；资源文件用 kebab-case/snake_case。
+- **命名规范**：类/Composable 用 PascalCase；函数/变量用 camelCase；资源文件用 kebab-case/snake_case。
+  `const val` 编译期常量用 UPPER_SNAKE_CASE。
+  **例外**：`core/designsystem/` 里的设计 token（`BrandGreen`、`MetricRed`、`AppBackground`、
+  `MetricValueStyle` 等）一律用 PascalCase —— 它们是 Compose 惯用的公开设计 token，不是 `const val`，
+  且 Tasks 3–12 的组件与页面都按这些确切名字引用，改名会破坏接口契约。此例外即本约束的一部分。
 - **注释规范**：每个类与公开函数上方写中文 KDoc，说明用途（团队规范要求）。
 - **提交规范**：每个 Task 结束提交一次；提交信息用中文，前缀 `feat:` / `chore:` / `test:` / `docs:`。
 - **Gitea 地址**：`http://120.192.101.56:3000/cuiluzheng/<repo>.git`（凭据助手已按主机配置好，可直接推送）。