841faca34a
- 新增项目规范文档,包含语言设置和 Git 提交规范 - 更新 .gitignore 文件,添加环境文件和数据目录 - 新增 Prettier 配置文件和忽略文件 - 更新 package.json,添加 prettier 和 prisma 相关依赖 - 新增 API 路由处理佣金和消费数据 这些更改为项目提供了更好的结构和代码风格规范。
37 lines
1.0 KiB
Plaintext
37 lines
1.0 KiB
Plaintext
# 项目规范
|
||
|
||
## 语言设置
|
||
- 所有回复、注释、文档必须使用中文
|
||
|
||
## Git Commit 规范
|
||
- Commit message 遵循 Conventional Commits 规范
|
||
- Git commit message 必须使用中文编写
|
||
- 格式:
|
||
```
|
||
<type>(<scope>): <subject>
|
||
|
||
<body>
|
||
|
||
<footer>
|
||
```
|
||
- 类型:feat | fix | docs | style | refactor | perf | test | chore | ci | types | revert
|
||
- 范围(可选):表示改动影响的模块,按项目实际模块划分即可
|
||
- 描述:不超过 50 个字符,使用祈使语气,首字母不大写(英文时适用),结尾不加句号
|
||
- **Header**(必填):`类型(范围): 简短描述`
|
||
- **Body**(选填):详细说明改动动机和前后行为对比
|
||
- **Footer**(选填):不兼容变更说明(BREAKING CHANGE)
|
||
- 示例:
|
||
```
|
||
feat(cart): 支持批量删除商品
|
||
|
||
- 添加多选交互
|
||
- 优化删除接口性能
|
||
- 更新测试用例
|
||
|
||
BREAKING CHANGE: 移除旧版删除接口
|
||
```
|
||
|
||
## 代码规范
|
||
- 变量和函数使用小驼峰命名(camelCase)
|
||
- 代码注释使用中文
|