Skip to content

Commit 8a29169

Browse files
sim-wangyansim-wangyan
committed
doc remove someting
1 parent 000d789 commit 8a29169

File tree

4 files changed

+216
-790
lines changed

4 files changed

+216
-790
lines changed

‎.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# 提交信息临时文件（本地使用，不提交）
2+
commit_message/COMMIT_MESSAGE_DRAFT*.txt
3+
commit_message/temp*.txt
4+
5+
# IDE
6+
.idea/
7+
.vscode/
8+
*.swp
9+
*.swo
10+
11+
# 测试覆盖率
12+
coverage.out
13+
*.test
14+
15+
# 编译产物
16+
*.exe
17+
*.exe~
18+
*.dll
19+
*.so
20+
*.dylib
21+
22+
# Go workspace
23+
go.work
24+
go.work.sum
25+
26+
# 临时文件
27+
*.tmp
28+
*.bak
29+
*~
30+
31+
# OS
32+
.DS_Store
33+
Thumbs.db

‎commit_message/README.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# 提交信息管理
2+
3+
本目录用于管理 Git 提交信息，包括历史提交记录和模板。
4+
5+
---
6+
7+
## 📁 目录结构
8+
9+
```
10+
commit_message/
11+
├── README.md # 本说明文件
12+
├── COMMIT_MESSAGE_v0.9.1.txt # v0.9.1 提交信息（中文）✅ 已提交
13+
├── COMMIT_MESSAGE_v0.9.1_EN.txt # v0.9.1 提交信息（英文）✅ 已提交
14+
└── TEMPLATE.txt # 提交信息模板（未来使用）
15+
```
16+
17+
---
18+
19+
## 📝 文件说明
20+
21+
### 已使用的提交信息
22+
23+
格式：`COMMIT_MESSAGE_vX.Y.Z.txt` 和 `COMMIT_MESSAGE_vX.Y.Z_EN.txt`
24+
25+
- **用途**: 记录历史版本的提交信息
26+
- **版本控制**: ✅ 提交到 Git（作为文档）
27+
- **作用**:
28+
- 规范化提交信息格式
29+
- 方便未来查阅版本变更
30+
- 作为 Release Notes 参考
31+
32+
### 提交信息模板
33+
34+
格式：`TEMPLATE.txt`
35+
36+
- **用途**: 作为未来提交的模板
37+
- **版本控制**: ✅ 提交到 Git（共享规范）
38+
39+
### 临时文件
40+
41+
格式：`COMMIT_MESSAGE_DRAFT*.txt`, `temp*.txt`
42+
43+
- **用途**: 本地草稿，测试用
44+
- **版本控制**: ❌ 被 `.gitignore` 忽略
45+
46+
---
47+
48+
## 🚀 使用方法
49+
50+
### 1. 使用已有的提交信息
51+
52+
```bash
53+
# 提交代码
54+
git add .
55+
git commit -F commit_message/COMMIT_MESSAGE_v0.9.1.txt
56+
57+
# 或使用英文版
58+
git commit -F commit_message/COMMIT_MESSAGE_v0.9.1_EN.txt
59+
```
60+
61+
### 2. 创建新版本的提交信息
62+
63+
```bash
64+
# 复制模板
65+
cp commit_message/TEMPLATE.txt commit_message/COMMIT_MESSAGE_v0.9.2.txt
66+
67+
# 编辑提交信息
68+
# ... 修改 COMMIT_MESSAGE_v0.9.2.txt
69+
70+
# 使用
71+
git commit -F commit_message/COMMIT_MESSAGE_v0.9.2.txt
72+
```
73+
74+
### 3. 本地草稿（不提交到 Git）
75+
76+
```bash
77+
# 创建草稿
78+
cp commit_message/TEMPLATE.txt commit_message/COMMIT_MESSAGE_DRAFT.txt
79+
80+
# 编辑草稿
81+
# ... 修改
82+
83+
# 使用（这个文件不会被 Git 追踪）
84+
git commit -F commit_message/COMMIT_MESSAGE_DRAFT.txt
85+
```
86+
87+
---
88+
89+
## 📋 提交信息规范
90+
91+
### 格式
92+
93+
```
94+
<type>(<scope>): <subject>
95+
96+
<body>
97+
98+
<footer>
99+
```
100+
101+
### Type（类型）
102+
103+
- `feat`: 新功能
104+
- `fix`: Bug 修复
105+
- `docs`: 文档变更
106+
- `style`: 代码格式（不影响功能）
107+
- `refactor`: 重构（不是新功能，也不是修复 bug）
108+
- `perf`: 性能优化
109+
- `test`: 测试相关
110+
- `chore`: 构建过程或辅助工具的变动
111+
112+
### Scope（范围）
113+
114+
- `core`: 核心功能
115+
- `vector`: 向量数据库
116+
- `qdrant`: Qdrant 集成
117+
- `test`: 测试
118+
- `doc`: 文档
119+
120+
### 示例
121+
122+
```
123+
fix(core): 修复 float64/int 零值过滤和 OR/AND 子查询处理
124+
125+
**问题 (Issues Fixed)**:
126+
127+
1. **float64/int 零值无法过滤**
128+
- `interface{} == 0` 对 float64 类型无效
129+
- 需要类型断言后再比较：`v.(float64) == 0.0`
130+
131+
2. **向量查询中 OR/AND 子查询渲染错误**
132+
- `SqlOfVectorSearch` 使用简化的 `buildConditionSql`
133+
- 该方法忽略 `subs`，导致 OR_SUB 输出为 `OR OR ?`
134+
- 修复：改用正确的 `toCondSql()`
135+
136+
**版本 (Version)**: v0.9.1
137+
```
138+
139+
---
140+
141+
## 🔄 CI/CD 集成
142+
143+
如果需要在 CI/CD 中使用这些提交信息：
144+
145+
```yaml
146+
# .github/workflows/release.yml
147+
- name: Create Release
148+
run: |
149+
# 使用提交信息创建 Release Notes
150+
gh release create ${{ github.ref }} \
151+
--title "Release ${{ github.ref }}" \
152+
--notes-file commit_message/COMMIT_MESSAGE_${VERSION}.txt
153+
```
154+
155+
---
156+
157+
## 📚 历史版本
158+
159+
- **v0.9.1**: 修复 float64/int 零值过滤和 OR/AND 子查询处理
160+
- 文件: `COMMIT_MESSAGE_v0.9.1.txt`
161+
- 日期: 2025-01
162+
163+
---
164+
165+
## ✅ 最佳实践
166+
167+
1. **版本提交信息**: ✅ 提交到 Git
168+
- 作为文档保存
169+
- 方便未来查阅
170+
- 规范团队提交格式
171+
172+
2. **临时草稿**: ❌ 不提交
173+
- 本地测试使用
174+
- 避免污染仓库
175+
176+
3. **模板文件**: ✅ 提交到 Git
177+
- 统一团队规范
178+
- 新贡献者参考
179+
180+
---
181+
182+
*本目录由 AI (Claude) 协助创建和维护*
183+

0 commit comments

Comments
 (0)