@bovinphang/frontend-craft 2.6.0 → 2.8.0

package/templates/shared/rules/fec-git-conventions.md

@@ -1,8 +1,8 @@
-# Git 提交规范
+# Git commit specifications
 
-凡是创建 commit、编写 commit message 或准备提交代码时，都应用本文件。
+This file should be used whenever creating a commit, writing a commit message, or preparing to submit code.
 
-## Conventional Commits 格式
+## Conventional Commits Format
 
 ```
 <type>(<scope>): <subject>
@@ -12,62 +12,62 @@
 [footer]
 ```
 
-### type 取值
+### type value
 
-| type | 用途 |
+| type | purpose |
 |------|------|
-| `feat` | 新功能 |
-| `fix` | 修复 bug |
-| `refactor` | 重构（不改变行为） |
-| `style` | 代码格式调整（不影响逻辑） |
-| `docs` | 文档变更 |
-| `test` | 测试相关 |
-| `chore` | 构建、工具、依赖等杂项 |
-| `perf` | 性能优化 |
-| `ci` | CI/CD 配置变更 |
+| `feat` | New features |
+| `fix` | Fix bug |
+| `refactor` | Refactor (does not change behavior) |
+| `style` | Code format adjustment (does not affect logic) |
+| `docs` | Documentation changes |
+| `test` | Test related |
+| `chore` | Build, tools, dependencies and other miscellaneous items |
+| `perf` | Performance optimization |
+| `ci` | CI/CD configuration changes |
 
 ### scope
 
-可选，标明影响范围，如模块名、组件名或功能域：
+Optional, indicate the scope of influence, such as module name, component name or functional domain:
 
-- `feat(auth): 新增手机号登录`
-- `fix(table): 修复排序列未高亮`
-- `refactor(api): 统一请求错误处理`
+- `feat(auth): add new mobile phone number to log in`
+- `fix(table): Fix sorting column not highlighted`
+- `refactor(api): unified request error handling`
 
-### subject 规范
+### subject specification
 
-- 使用祈使句（"增加 xxx" 而非 "增加了 xxx"）
-- 不超过 72 个字符
-- 不以句号结尾
-- 如果影响范围较大，在 body 中详细说明
+- Use imperative sentences ("increased xxx" instead of "increased xxx")
+- No more than 72 characters
+- does not end with a period
+- If the scope of impact is large, describe it in detail in the body
 
-## 分支命名
+## Branch naming
 
-- `feature/xxx` — 新功能
-- `fix/xxx` — 修复
-- `refactor/xxx` — 重构
-- `hotfix/xxx` — 紧急修复
+- `feature/xxx` — new features
+- `fix/xxx` — fix
+- `refactor/xxx` — Refactor
+- `hotfix/xxx` — emergency fix
 
-## 提交前检查
+## Check before submission
 
-提交前必须通过：
+Must pass before submission:
 
 1. lint
 2. type-check
-3. 与变更相关的测试
+3. Testing related to changes
 
-未经用户确认不要直接执行 `git commit`。
+Do not execute `git commit` directly without user confirmation.
 
-## 提交粒度
+## Submission granularity
 
-- 一个提交只包含一个清晰目的：功能、修复、测试、文档或清理。
-- 大型计划应拆成可验证的小批次，每批都有说明和命令结果。
-- 清理、格式化和行为变更不要混在同一提交中。
-- 推送或发 PR 前先复查 diff，确认没有本地配置、密钥、临时报告或调试输出。
+- A commit only has one clear purpose: feature, fix, test, documentation or cleanup.
+- Large programs should be broken into verifiable smaller batches, each with instructions and command results.
+- Don't mix cleanup, formatting, and behavior changes in the same commit.
+- Review the diff before pushing or sending a PR to make sure there are no local configurations, keys, temporary reports or debug output.
 
-## 反模式
+## Anti-pattern
 
-- 一个 commit 混合不相关的改动
-- commit message 过于笼统（如 "update"、"fix bug"、"wip"）
-- 在 commit 中包含调试代码、console.log 或临时 hack
-- 未说明验证命令或已知剩余风险就提交高风险改动
+- A commit that mixes unrelated changes
+- The commit message is too general (such as "update", "fix bug", "wip")
+- Include debug code, console.log, or temporary hacks in commits
+- Commit high-risk changes without specifying verification commands or knowing the remaining risk

package/templates/shared/rules/fec-i18n.md

@@ -1,112 +1,64 @@
-# 国际化 (i18n) 规则
+# Internationalization (i18n) rules
 
-凡是涉及用户可见文案、提示信息、表单标签、错误消息或 UI 文本时，都应用本文件。
+This document applies whenever it involves user-visible copy, tooltips, form labels, error messages, or UI text. Please modify the locales path, library and key prefix according to the actual i18n solution of the project.
 
-<!-- 请根据项目实际 i18n 方案修改 locales 路径、库与 key 前缀 -->
+## Scope of application
 
-## 适用范围
+- **Modern stack (React/Vue/Next/Nuxt, etc.)**: New or modified user-visible copy must follow the project i18n solution.
+- **Legacy HTML/JS, progressive migration or coexistence of old and new**: The new code path must still meet the core principles; the legacy layer adheres to migration constraints to avoid expanding hard coding and confusing keys.
 
-- **现代栈（纯 React / Vue 等）**：以下「核心原则」「文案规范」「实现指导」与通用检查清单优先适用。
-- **遗留 HTML/JS、渐进迁移或新旧并存**：新代码路径仍须满足核心原则；遗留层额外遵守「遗留代码与迁移场景」，避免扩大硬编码与混乱 key。
+`src/locales/` is used below to refer to the actual copywriting resource directory of the project. Please replace it according to the warehouse convention.
 
-下文用 **`src/locales/`** 指代项目实际文案资源目录，请按仓库约定替换（如 `public/locales`、`lang/`、`messages/` 等）。
+## Core Principles
 
-## 核心原则
+- User-visible copy in new application code must use i18n, and hardcoding Chinese or English strings is prohibited.
+- i18n keys are organized by modules and named with dots, such as `order.list.empty`.
+- Copies with the same semantics reuse the same key to avoid repeated definitions.
+- Variables, plurals, dates, numbers and currencies are formatted using i18n capabilities without string concatenation.
+- Search existing resources before modifying the copy, and give priority to reusing accurate keys.
 
-- 在新应用代码（组件、路由页、hooks、composables）中，用户可见文案须使用 i18n，**禁止**硬编码中文或英文字符串
-- i18n key 按模块组织，使用点分命名：`module.component.label`
-- 相同语义的文案复用同一个 key，避免重复定义
+## Copywriting and resource specifications
 
-## 文案规范
+- `common.*` is used for cross-module common copywriting, such as confirm, cancel, submit, and loading.
+- `module.component.*` is used for module-level copy.
+- `validation.*` is used for form validation prompts.
+- `error.*` for error messages.
+- Each natural language corresponds to an independent resource file, and multiple languages are prohibited from being mixed in the same file or the same top-level multi-language object.
+- Copywriting files must be saved in UTF-8; when the team has an agreement, priority will be given to UTF-8 without BOM to avoid garbled non-ASCII copywriting in Chinese, Japanese and other languages.
+- When adding a key, the main language files that should be covered by the current function are updated simultaneously; if a language is temporarily missing, the gap must be explicitly recorded.
 
-### 命名约定
+## Legacy code and migration scenarios
 
-```
-common.confirm        → 通用确认
-common.cancel         → 通用取消
-user.login.title      → 用户登录标题
-order.list.empty      → 订单列表空状态
-```
+- No new user-visible hardcoding is added in legacy HTML or JS, unless the segment is purely static and the repository does not yet have access to the i18n path.
+- When new code paths such as React/Vue add prompts, errors, buttons, and form labels, i18n must be used.
+- When adding new sub-applications or modules, they should be consistent with the existing language file structure, namespace and lazy loading strategy.
+- Keys are organized by page, module and semantics to avoid continuing to use historical abbreviations or meaningless segments.
+- If the old key is only "usable but inaccurate", priority will be given to renaming the key and rewriting the translation, and parallel compatibility will not be maintained for a long time.
+- Only introduce mapping layer or alias transition when the old key has become an external contract (fixed reference in backend, buried points, external documents, third-party integration, etc.).
 
-### 分类
+## Implement constraints
 
-- `common.*` — 跨模块通用文案（确认、取消、提交、加载中等）
-- `module.component.*` — 模块级文案
-- `validation.*` — 表单校验提示
-- `error.*` — 错误信息
+- The specific calling methods of Vue, React, Next, and Nuxt are subject to the existing i18n library of the project, such as `vue-i18n`, `react-intl`, `react-i18next` or the framework's built-in solution.
+- Do not directly write user-visible hard coding in components; tests can assert through key or final copywriting, but should avoid over-coupling with translation details.
+- When lazily loading language packs, loading, fallback, and missing key behaviors must be predictable.
+- Error, form, and empty state copy should express the user’s next step, not just translate technical errors.
 
-### 语言文件
+## Checklist
 
-- **每种自然语言对应独立资源文件**（命名依项目约定，如 `en.json` 与 `zh-CN.json`，或 `en.ts` / `zh-CN.ts`），置于 `src/locales/`（或项目约定目录）下；**禁止**将多种语言的译文混写在同一文件或同一顶层多语言对象内，以免难以 diff、评审与按需加载。若仓库历史结构暂为混排，新增语言或新模块仍应优先采用分文件约定。
-- **编码**：文案文件须以 **UTF-8** 保存（团队有约定时优先 **UTF-8 无 BOM**），确保在 IDE 中打开时中文、日文等非 ASCII 字符**不出现乱码**；禁止用系统默认 ANSI、GBK 等与 UTF-8 混用导致编码误判。若仓库已有 `.editorconfig`，与其中 `charset = utf-8` 等声明保持一致。
+- [ ] All newly added user-visible copy uses i18n key.
+- [ ] The new key has been added to all language files that should be covered, and each language is maintained in separate files.
+- [ ] The language resource file is UTF-8, and there will be no garbled characters when opened.
+- [ ] key naming conforms to module, component, and usage conventions, and reuses existing semantics.
+- [ ] Interpolation, complex numbers, dates, numbers, currencies are formatted using i18n.
+- [ ] User-visible hardcoding not expanded in migration or hybrid stacks.
+- [ ] The new code does not break existing namespaces, loading methods, and sub-app boundaries.
 
-## 遗留代码与迁移场景
+## Anti-pattern
 
-在渐进式迁移、微前端或新旧代码并存时：
-
-- **遗留层**：不在 legacy HTML 或 JS 中**新写**用户可见的中/英文硬编码，除非该段为纯静态展示且仓库**尚未**建立可接入的国际化路径（避免扩大技术债）。
-- **新代码路径**：React / Vue 等侧新增、修改的提示、错误、按钮、表单标签等，须走 i18n；新增子应用或模块时，须与现有语言文件结构、命名空间、懒加载策略一致，**不破坏**既有语言策略。
-- **复用优先**：同一语义优先复用已有 key 或已有资源项，避免同一含义多份翻译。
-- **多语言同步**：新增或修改条目后，至少核对当前功能已覆盖的**主要语言文件**是否一并更新。
-- **改动前检索**：改提示、错误、按钮、表单标签前，先在 `src/locales/`（或项目约定目录）中搜索是否已有对应文案。
-- **Key 与文案治理**：
-  - key 按**页面 / 模块 / 语义**组织，避免继续沿用历史缩写或无意义分段。
-  - 先按当前界面真实含义定 key，再写各语言译文。
-  - 旧文案若仅「能用但不准」，优先**重命名 key 并重写译文**，不为劣质命名长期保留并行兼容。
-  - 仅当某旧 key 已成为**对外契约**（后端、埋点、外部文档、第三方集成等固定引用）时，才引入映射层或别名过渡；否则不把历史包袱复制进新结构。
-
-## 实现指导
-
-### Vue（vue-i18n）
-
-```vue
-<template>
-  <!-- 正确 -->
-  <span>{{ $t('order.status.pending') }}</span>
-  <!-- 错误：硬编码 -->
-  <span>待处理</span>
-</template>
-```
-
-### React（react-intl / react-i18next）
-
-```tsx
-// 正确
-<FormattedMessage id="order.status.pending" />
-// 或
-const { t } = useTranslation();
-<span>{t('order.status.pending')}</span>
-
-// 错误：硬编码
-<span>待处理</span>
-```
-
-## 检查清单
-
-### 通用
-
-- [ ] 所有新增用户可见文案使用 i18n key（新代码路径）
-- [ ] 新增 key 已添加到所有**应覆盖**的语言文件，且各语言仍分文件维护（未混写）
-- [ ] 语言资源文件为 UTF-8（无 BOM 或按仓库约定），在 IDE 中打开无乱码
-- [ ] key 命名符合模块.组件.用途 的约定
-- [ ] 包含变量的文案使用插值而非拼接
-- [ ] 复数形式使用 i18n 复数规则而非条件判断
-- [ ] 日期、数字、货币使用 i18n 格式化
-
-### 迁移或混合栈时补充
-
-- [ ] 已检索 `src/locales/`（或项目约定目录）中是否已有可复用文案
-- [ ] 相关语言文件已同步更新
-- [ ] 未在可国际化路径上新增用户可见硬编码（遗留静态例外见「遗留代码与迁移场景」）
-- [ ] 新代码未破坏现有语言策略（命名空间、加载方式、子应用边界）
-
-## 反模式
-
-- 在模板或 JSX 中直接写中文字符串（新代码路径）
-- 使用字符串拼接代替 i18n 插值（`"共" + count + "条"` → `t('common.total', { count })`）
-- 在 JS/TS 逻辑中硬编码提示信息（新代码路径）
-- 不同模块为相同含义的文案创建不同的 key
-- 多种语言混在同一资源文件或同一顶层对象内，导致 diff、评审与按需加载困难
-- 用非 UTF-8 或错误编码保存文案文件，在 IDE / CI / 协作环境下出现乱码
-- 为迁就历史缩写或劣质命名长期保留多套并行 key，而不做治理
-- 在非契约场景下继续沿用无意义旧 key，把混乱结构复制到新模块
+- Write user-visible Chinese or English strings directly in templates or JSX.
+- Use string concatenation instead of i18n interpolation.
+- Hardcode toast, error or confirmation text in JS/TS logic.
+- Different modules create different keys for the same meaning.
+- Mixing multiple languages makes diffing, reviewing and on-demand loading difficult.
+- Save copy files in non-UTF-8 or incorrect encoding.
+- Long-term retention of multiple sets of parallel keys to accommodate historical abbreviations or poor naming.

package/templates/shared/rules/fec-naming-conventions.md

@@ -1,33 +1,33 @@
-# 命名规范
+# Naming convention
 
-## 文件与目录命名
+## File and directory naming
 
-| 类型 | 命名风格 | 示例 |
+| Type | Naming Style | Example |
 |------|----------|------|
-| 页面组件 | PascalCase + `Page` 后缀 | `UserDetailPage.tsx` / `UserDetailPage.vue` |
-| 布局组件 | PascalCase + `Layout` 后缀 | `MainLayout.tsx` / `MainLayout.vue` |
-| 通用组件 | PascalCase | `DataTable.tsx` / `AppButton.vue` |
-| Hooks / Composables | camelCase + `use` 前缀 | `useAuth.ts`、`useDebounce.ts` |
-| Store 文件 | camelCase + `Store` 后缀 | `authStore.ts`、`uiStore.ts` |
-| API 文件 | camelCase | `api.ts` 或按领域命名 `userApi.ts` |
-| 工具函数 | camelCase | `format.ts`、`validators.ts` |
-| 类型文件 | camelCase | `types.ts`、`models.ts` |
-| 常量文件 | camelCase | `constants.ts`、`config.ts` |
-| 测试文件 | 与源文件同名 + `.spec` / `.test` | `Button.spec.tsx`、`useAuth.spec.ts` |
-| 样式文件 | 组件名 + `.styles` + 扩展名 | `Button.styles.css`、`DataTable.styles.scss`；使用 styled-components 时为 `ComponentName.styles.ts` |
-| 语言包 | 语言代码（BCP 47） | `zh-CN.json`、`en-US.json` |
-| 目录名 | PascalCase（组件/页面）或 kebab-case（功能模块） | `UserDetail/`、`auth/`、`order/` |
-
-## 组件命名
+| Page component | PascalCase + `Page` suffix | `UserDetailPage.tsx` / `UserDetailPage.vue` |
+| Layout component | PascalCase + `Layout` suffix | `MainLayout.tsx` / `MainLayout.vue` |
+| Common components | PascalCase | `DataTable.tsx` / `AppButton.vue` |
+| Hooks / Composables | camelCase + `use` prefix | `useAuth.ts`, `useDebounce.ts` |
+| Store file | camelCase + `Store` suffix | `authStore.ts`, `uiStore.ts` |
+| API documentation | camelCase | `api.ts` or by domain `userApi.ts` |
+| Utility functions | camelCase | `format.ts`, `validators.ts` |
+| Type files | camelCase | `types.ts`, `models.ts` |
+| Constant files | camelCase | `constants.ts`, `config.ts` |
+| Test file | Same name as source file + `.spec` / `.test` | `Button.spec.tsx`, `useAuth.spec.ts` |
+| Style file | Component name + `.styles` + extension | `Button.styles.css`, `DataTable.styles.scss`; `ComponentName.styles.ts` when using styled-components |
+| Language pack | Language code (BCP 47) | `zh-CN.json`, `en-US.json` |
+| Directory name | PascalCase (component/page) or kebab-case (function module) | `UserDetail/`, `auth/`, `order/` |
+
+## Component naming
 
 ### React
 
 ```tsx
-// 文件名与组件名一致
+//The file name is consistent with the component name
 // src/components/DataTable/DataTable.tsx
 export function DataTable({ data, columns }: DataTableProps) { ... }
 
-// 页面组件加 Page 后缀
+//Add Page suffix to page component
 // src/pages/UserDetail/UserDetailPage.tsx
 export default function UserDetailPage() { ... }
 ```
@@ -35,86 +35,86 @@ export default function UserDetailPage() { ... }
 ### Vue
 
 ```vue
-<!-- 文件名与组件名一致 -->
+<!-- The file name is consistent with the component name -->
 <!-- src/components/AppButton/AppButton.vue -->
 <script setup lang="ts">
-// 无需 defineOptions，文件名即组件名
+// No need for defineOptions, the file name is the component name
 </script>
 ```
 
-- 多词组件名（避免与 HTML 原生标签冲突）
-- Vue 全局组件推荐使用 `App` 前缀（`AppButton`、`AppModal`）
-- 模板中使用 PascalCase 引用：`<AppButton>` 而非 `<app-button>`
+- Multi-word component names (to avoid conflicts with HTML native tags)
+- Vue global components are recommended to use the `App` prefix (`AppButton`, `AppModal`)
+- Use PascalCase reference in template: `<AppButton>` instead of `<app-button>`
 
-## 变量与函数命名
+## Variable and function naming
 
-| 类型 | 命名风格 | 示例 |
+| Type | Naming Style | Example |
 |------|----------|------|
-| 普通变量 | camelCase | `userName`、`isLoading`、`pageSize` |
-| 常量 | UPPER_SNAKE_CASE | `MAX_RETRY_COUNT`、`DEFAULT_PAGE_SIZE` |
-| 布尔值 | `is` / `has` / `should` / `can` 前缀 | `isVisible`、`hasPermission`、`canEdit` |
-| 事件处理（组件内） | `handle` 前缀 | `handleClick`、`handleSubmit` |
-| 回调 Props | `on` 前缀 | `onClick`、`onSubmit`、`onChange` |
-| 数组 | 复数名词 | `users`、`orderItems`、`selectedIds` |
-| Map / Record | `xxxMap` 或 `xxxByYyy` | `userMap`、`permissionsById` |
-| Ref (Vue) | 不加 `Ref` 后缀 | `count`（不用 `countRef`） |
-| 接口 | PascalCase，不加 `I` 前缀 | `UserProfile`（不用 `IUserProfile`） |
-| Props 接口 | 组件名 + `Props` | `DataTableProps`、`UserFormProps` |
-| Emits 接口 | 组件名 + `Emits` | `UserFormEmits` |
-| 枚举 | PascalCase，成员用 PascalCase | `OrderStatus.Pending` |
-| 泛型参数 | 单字母大写或语义化 | `T`、`TData`、`TItem` |
-
-## CSS 类命名
-
-- 与项目约定保持一致（BEM / CSS Modules / Tailwind / Atomic CSS）
-- 如果使用 CSS Modules，类名用 camelCase：`.headerTitle`、`.cardBody`
-- 如果使用 BEM，遵循 `block__element--modifier` 格式
-- CSS 变量使用 kebab-case：`--color-primary`、`--spacing-md`
-
-## 路由命名
-
-| 类型 | 命名风格 | 示例 |
+| Ordinary variables | camelCase | `userName`, `isLoading`, `pageSize` |
+| Constants | UPPER_SNAKE_CASE | `MAX_RETRY_COUNT`, `DEFAULT_PAGE_SIZE` |
+| Boolean value | `is` / `has` / `should` / `can` prefix | `isVisible`, `hasPermission`, `canEdit` |
+| Event handling (inside component) | `handle` prefix | `handleClick`, `handleSubmit` |
+| Callback Props | `on` prefix | `onClick`, `onSubmit`, `onChange` |
+| Array | Plural noun | `users`, `orderItems`, `selectedIds` |
+| Map / Record | `xxxMap` or `xxxByYyy` | `userMap`, `permissionsById` |
+| Ref (Vue) | Without `Ref` suffix | `count` (without `countRef`) |
+| Interface | PascalCase, without `I` prefix | `UserProfile` (without `IUserProfile`) |
+| Props interface | component name + `Props` | `DataTableProps`, `UserFormProps` |
+| Emits interface | component name + `Emits` | `UserFormEmits` |
+| Enum | PascalCase, members use PascalCase | `OrderStatus.Pending` |
+| Generic parameters | Single letter capitalization or semantic | `T`, `TData`, `TItem` |
+
+## CSS class naming
+
+- Aligned with project conventions (BEM/CSS Modules/Tailwind/Atomic CSS)
+- If using CSS Modules, use camelCase for class names: `.headerTitle`, `.cardBody`
+- If using BEM, follow the `block__element--modifier` format
+- CSS variables use kebab-case: `--color-primary`, `--spacing-md`
+
+## Route naming
+
+| Type | Naming Style | Example |
 |------|----------|------|
-| 路由路径 | kebab-case | `/user-detail`、`/order-list` |
-| 路由名称 | PascalCase | `UserDetail`、`OrderList` |
-| 路由参数 | camelCase | `:userId`、`:orderId` |
-| 查询参数 | camelCase | `?pageSize=10&sortBy=name` |
-| 路径常量 | UPPER_SNAKE_CASE | `ROUTE_USER_DETAIL = '/user-detail'` |
+| routing path | kebab-case | `/user-detail`, `/order-list` |
+| Route name | PascalCase | `UserDetail`, `OrderList` |
+| Routing parameters | camelCase | `:userId`, `:orderId` |
+| Query parameters | camelCase | `?pageSize=10&sortBy=name` |
+| Path constants | UPPER_SNAKE_CASE | `ROUTE_USER_DETAIL = '/user-detail'` |
 
-## API 命名
+## API naming
 
-| 类型 | 命名风格 | 示例 |
+| Type | Naming Style | Example |
 |------|----------|------|
-| GET 列表 | `getXxxList` | `getUserList(params)` |
-| GET 单条 | `getXxxDetail` / `getXxxById` | `getUserDetail(id)` |
-| POST 创建 | `createXxx` | `createOrder(data)` |
-| PUT 更新 | `updateXxx` | `updateUser(id, data)` |
-| DELETE 删除 | `deleteXxx` | `deleteOrder(id)` |
-| DTO 类型 | 动词 + 名词 + `DTO` | `CreateOrderDTO`、`UpdateUserDTO` |
-| 响应类型 | 名词 | `User`、`Order`、`PageResult<User>` |
-
-## i18n Key 命名
-
-- 使用点分命名空间：`module.section.label`
-- 示例：`user.form.username`、`common.button.submit`、`error.network.timeout`
-- 不使用中文 / 拼音作为 key
-
-## 反模式
-
-- 文件名和组件名不一致（`user-table.tsx` 导出 `DataGrid`）
-- 同一项目混用多种命名风格（有的 kebab-case 有的 PascalCase）
-- 使用缩写或不明确的名称（`btn`、`usr`、`tmp`、`handleA`）
-- 布尔值没有语义前缀（`visible` → 应为 `isVisible`）
-- 常量不用大写（`maxRetry` → 应为 `MAX_RETRY`）
-- CSS 变量硬编码在组件中而非使用统一变量
-
-## 检查清单
-
-- [ ] 文件名与导出的组件/函数名一致
-- [ ] 页面组件有 `Page` 后缀，布局组件有 `Layout` 后缀
-- [ ] 布尔变量使用 `is` / `has` / `can` / `should` 前缀
-- [ ] 事件处理用 `handle` 前缀，回调 Props 用 `on` 前缀
-- [ ] 常量使用 UPPER_SNAKE_CASE
-- [ ] 路由路径使用 kebab-case，路由名使用 PascalCase
-- [ ] API 函数命名与 HTTP 方法语义一致
-- [ ] i18n key 使用点分命名空间，无硬编码文案
+| GET list | `getXxxList` | `getUserList(params)` |
+| GET single item | `getXxxDetail` / `getXxxById` | `getUserDetail(id)` |
+| POST Create | `createXxx` | `createOrder(data)` |
+| PUT update | `updateXxx` | `updateUser(id, data)` |
+| DELETE delete | `deleteXxx` | `deleteOrder(id)` |
+| DTO type | Verb + Noun + `DTO` | `CreateOrderDTO`, `UpdateUserDTO` |
+| Response type | Noun | `User`, `Order`, `PageResult<User>` |
+
+## i18n Key naming
+
+- Use dotted namespace: `module.section.label`
+- Examples: `user.form.username`, `common.button.submit`, `error.network.timeout`
+- Do not use Chinese/Pinyin as key
+
+## Anti-pattern
+
+- File name and component name are inconsistent (`user-table.tsx` exports `DataGrid`)
+- Mixing multiple naming styles (some kebab-case, some PascalCase) in the same project
+- Use abbreviated or ambiguous names (`btn`, `usr`, `tmp`, `handleA`)
+- Boolean values have no semantic prefix (`visible` → should be `isVisible`)
+- Constants do not need to be capitalized (`maxRetry` → should be `MAX_RETRY`)
+- CSS variables are hardcoded in components instead of using uniform variables
+
+## Checklist
+
+- [ ] The file name is consistent with the exported component/function name
+- [ ] Page components have the `Page` suffix, and layout components have the `Layout` suffix.
+- [ ] Boolean variables use `is` / `has` / `can` / `should` prefixes
+- [ ] Event handling is prefixed with `handle`, callback Props are prefixed with `on`
+- [ ] constant using UPPER_SNAKE_CASE
+- [ ] Use kebab-case for the routing path and PascalCase for the routing name.
+- [ ] API function naming is consistent with HTTP method semantics
+- [ ] i18n key uses dotted namespace, no hardcoded copy