generated from zhongyidian/yx-react-template
51 lines
1.8 KiB
Plaintext
51 lines
1.8 KiB
Plaintext
# Commit Message 规则
|
|
|
|
所有 commit message 必须使用中文编写。
|
|
|
|
Commit message 格式：
|
|
- 类型: 简短描述（50字以内）
|
|
- 空行
|
|
- 详细描述（可选，72字以内换行）
|
|
|
|
类型包括：
|
|
- feat: 新功能
|
|
- fix: 修复 bug
|
|
- docs: 文档变更
|
|
- style: 代码格式（不影响代码运行的变动）
|
|
- refactor: 重构
|
|
- perf: 性能优化
|
|
- test: 增加测试
|
|
- chore: 构建过程或辅助工具的变动
|
|
- ci: 持续集成相关
|
|
- build: 构建系统或外部依赖的变更
|
|
|
|
示例：
|
|
```
|
|
fix: 修复 TypeScript 配置文件中的 lint 错误
|
|
|
|
- 添加 incremental 选项以支持 tsBuildInfoFile
|
|
- 移除不存在的 noUncheckedSideEffectImports 选项
|
|
```
|
|
|
|
React 项目工程化结构
|
|
```
|
|
src/
|
|
├── assets/ # 静态资源 (images, fonts, global svgs)
|
|
├── api/ # API 请求定义 (推荐用 Axios 或 React Query 封装)
|
|
├── components/ # 复用 UI 组件
|
|
│ ├── common/ # 原子级基础组件 (Button, Input, Modal)
|
|
│ ├── business/ # 业务逻辑组件 (UserCard, OrderList)
|
|
│ └── layout/ # 页面框架组件 (Header, Sidebar)
|
|
├── constants/ # 常量定义 (Enums, Configs)
|
|
├── hooks/ # 自定义全局 Hooks (useAuth, useLocalStorage)
|
|
├── pages/ # 页面级组件 (路由对应)
|
|
│ └── Home/
|
|
│ ├── index.tsx # 页面主入口
|
|
│ ├── components/ # 页面私有组件 (不对外复用)
|
|
│ └── hooks.ts # 页面私有逻辑
|
|
├── store/ # 状态管理 (Zustand, Redux, 或 Context)
|
|
├── styles/ # 全局样式 (Variables, Theme, Reset)
|
|
├── types/ # 全局 TypeScript 类型定义 (.d.ts)
|
|
└── utils/ # 工具函数 (date, format, validator)
|
|
```
|