Skip to content

Commit dd0c5ea

Browse files
committed
feat(project): 新增项目级规范目录 project/ 及模板
1 parent a4bef0d commit dd0c5ea

2 files changed

Lines changed: 122 additions & 0 deletions

File tree

project/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# 项目级编码规范
2+
3+
> `project/` 目录下按**项目名**存放独立的规范文件。
4+
> AI 优先读取 `memory.md`(个人偏好),再根据当前项目路径查找对应的项目规范文件并合并。
5+
6+
---
7+
8+
## 目录结构
9+
10+
```
11+
project/
12+
├── README.md # 本文件
13+
├── _template.md # 模板——新建项目时复制
14+
└── <项目名>.md # 按项目名命名的规范文件
15+
```
16+
17+
## 工作流程
18+
19+
当 AI 每次应用规约前:
20+
21+
```
22+
① 读取 memory.md → 载入个人偏好
23+
② 从工作目录推断当前项目名
24+
③ 查找 project/<项目名>.md
25+
④ 若存在 → 读取并合并到 memory.md 之上
26+
⑤ 若不存在 → 仅用 memory.md
27+
```
28+
29+
**项目名推断规则**:从当前工作目录路径中提取顶层项目目录名(如工作路径为 `D:\projects\物业系统\contract-service`,则项目名为 `物业系统`)。
30+
31+
## 创建新项目规范
32+
33+
1. 复制 `_template.md``<项目名>.md`
34+
2. 按实际情况填写各表格
35+
3. 提交到版本库,团队成员共享

project/_template.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# 项目编码规范:{{项目名称}}
2+
3+
> 📁 **项目级规范** — 记录 {{项目名称}} 的团队编码约定,按项目隔离。
4+
> AI 读取优先级:`memory.md`(个人)→ `project/<项目名>.md`(本文件)→ 手册原文(基线)
5+
6+
---
7+
8+
## 初始化方式
9+
10+
AI 首次在此项目加载本 skill 时,自动执行:
11+
12+
```
13+
① 检测到工作目录属于「{{项目名称}}」
14+
② 扫描 pom.xml / build.gradle → 推断技术栈
15+
③ 扫描现有代码 → 推断命名风格和分层模式
16+
④ 依次询问技术栈、规约覆盖、命名约定等问题
17+
⑤ 填充下方各表格 → 写入本文件
18+
```
19+
20+
**你只需回答 AI 的提问即可,无需手动填写。**
21+
22+
日常开发中,发现新规范时 AI 会询问是否加入本文件。
23+
24+
---
25+
26+
## 1. 项目元信息
27+
28+
| 字段 || 来源 |
29+
|------|----|------|
30+
| 项目名称 | {{项目名称}} | |
31+
| JDK 版本 | | 自动检测 |
32+
| 构建工具 | | 自动检测 |
33+
| Spring Boot 版本 | | 自动检测 |
34+
| 数据库 | | 自动检测 |
35+
| 生效日期 | | 初始化日期 |
36+
37+
## 2. 技术栈
38+
39+
| 技术领域 | 选型 | 备注 |
40+
|---------|------|------|
41+
| ORM | | |
42+
| 微服务框架 | | |
43+
| 缓存 | | |
44+
| 消息队列 | | |
45+
| 注册中心 | | |
46+
| RPC | | |
47+
| 单元测试 | | |
48+
49+
## 3. 手册规约覆盖
50+
51+
对阿里手册中部分规约的团队统一调整:
52+
53+
| 手册章节 | 原规约 | 团队覆盖 | 级别 | 原因 |
54+
|---------|--------|---------|------|------|
55+
| | | | | |
56+
57+
## 4. 自定义规约
58+
59+
该项目特有的、手册未覆盖的规范:
60+
61+
| 规约 | 级别 | 说明 |
62+
|------|------|------|
63+
| | | |
64+
65+
## 5. 命名约定
66+
67+
| 元素 | 约定 | 来源 |
68+
|------|------|------|
69+
| 数据库表 | | 自动检测或确认 |
70+
| 数据库字段 | | 自动检测或确认 |
71+
| Controller | | 自动检测或确认 |
72+
| Service 接口 | | 自动检测或确认 |
73+
| DTO | | 自动检测或确认 |
74+
| VO | | 自动检测或确认 |
75+
| 包名 | | 自动检测或确认 |
76+
77+
## 6. 例外清单
78+
79+
| 文件/位置 | 违反规约 | 豁免原因 | 计划修复时间 |
80+
|-----------|---------|---------|-------------|
81+
| | | | |
82+
83+
## 7. 更新日志
84+
85+
| 日期 | 更新内容 |
86+
|------|---------|
87+
| | |

0 commit comments

Comments
 (0)