diff --git a/README.md b/README.md index dadfad9..9675e9d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ -# hl-api-changelog +# 呼籁旅行 - 后端接口修改记录 -后端接口修改详细记录 - 自动同步 \ No newline at end of file +自动同步自主项目 `hl` 的每次 git commit,记录所有后端接口变更详情。 + +## 目录结构 + +``` +changelogs/ + 2026-03/ + 2026-03-16_abcd1234_fix-xxx.md # 每次提交一个文件 + 2026-03-16_efgh5678_feat-yyy.md + 2026-04/ + ... +``` + +## 记录内容 + +每条记录包含: +- 提交信息(hash、作者、时间、message) +- 修改的文件列表(新增/修改/删除) +- **Controller 接口变更详情**(新增/修改/删除的 API 端点) +- **DTO/VO 字段变更**(请求/响应对象的字段变化) +- **数据库变更**(SQL 脚本变化) +- **Nacos 配置变更** +- 完整 diff(Controller、DTO、VO 相关文件) + +## 自动同步 + +通过主项目的 `post-commit` hook 自动触发,每次 commit 后生成变更记录并推送到本仓库。