commit-changelog-workflow

name	commit-changelog-workflow
description	Fix or rename files, write a Chinese changelog MD, commit in English, and optionally push. Use when fixing garbled filenames, documenting changes in Chinese, committing with English messages, or when the user asks for the project's commit flow or to "写 skill 提交流程".

提交与改动说明流程

在修文件（如乱码文件名）、写中文改动说明、用英文提交并可选上传时，按本流程执行。

---

流程概览

1. 做内容/文件名修改
2. 写改动说明 MD（中文）
3. 确定改动说明放哪、是否上传
4. 英文 commit，可选 push

---

1. 做修改

• 重命名、改内容等按用户要求完成。
• 若涉及乱码文件名：用正确 UTF-8 中文命名（如 4.1-模仿学习.md），并删除旧乱码文件；README 等链接若已指向正确名，无需改。

---

2. 写改动说明 MD（中文）

必须执行：每次走本流程都要新建或更新一份改动说明 Markdown 文件，不可跳过。执行后应能在仓库里看到该文件。说明要写详细，便于直接整理成公众号文章：写清知识库添加了什么、内容是什么、链接在哪里。

• 放置位置：一律放在工程最外面（仓库根目录），例如 改动说明-人物README链接与简介.md 即位于项目根目录。
• 文件名示例：改动说明-XXX.md（如 改动说明-人物README链接与简介.md、改动说明-4.1-4.2文件名修复.md）。
• 语言：正文用中文。

固定格式（公众号向）

按下面结构逐项填写，每条都要写清：添加了什么、内容简介、链接位置。

# [本次主题] 知识库更新说明

> 用于公众号/对外发布：知识库新增与修订条目一览。

---

## 一、知识库新增/更新总览

| 类型 | 名称 | 路径 | 说明 |
|------|------|------|------|
| 来源/访谈/论文/文档 | 简短标题 | 仓库内相对路径 | 一两句内容概括 |

（表格行数按实际条目填写，类型可为：来源整理、访谈摘要、论文索引、文档修订、Skill 更新 等。）

---

## 二、逐条说明（内容 + 链接）

### 1. [条目名称]

- **知识库位置**：`仓库内路径`（如 `files/source/xxx.md`、`docs/5-sota/5.1-VLA.md`）。
- **内容概要**：（2～5 句：主题、关键信息、结论或用途。）
- **链接**：
  - 仓库内：`https://github.com/组织/仓库/blob/main/上述路径`
  - 若为外部来源：可附原文/报道链接。

### 2. [下一条目名称]

- **知识库位置**：…
- **内容概要**：…
- **链接**：…

（按实际条目数量重复「条目名称 + 知识库位置 + 内容概要 + 链接」。）

---

## 三、小结

- 本次共新增/修订 X 项，涵盖 …（类型或主题）。
- 本文档记录知识库更新内容与链接，便于公众号撰写与读者查阅。

• 填写要点：
  • 知识库添加了什么：在「一、总览」表格和「二、逐条说明」里写清每条的名称、路径、类型。
  • 内容是什么：在每条「内容概要」里用 2～5 句写主题、关键信息、结论或用途。
  • 链接在哪里：每条都给出仓库内路径，并写出可访问的 GitHub 链接（https://github.com/组织/仓库/blob/main/路径）；若有外部原文/报道，一并写上。
• 写完后可直接从本 MD 摘编为公众号文章（总览表 + 选几条做「内容概要 + 链接」即可）。

---

3. 改动说明是否随提交上传

改动说明文件已规定放在工程最外面（仓库根目录）。是否纳入版本库由用户决定：

用户要求	做法
随提交上传	将根目录下的 改动说明-XXX.md 随 git add 一起提交。
不上传	把该文件名加入 .gitignore，不 git add 该文件。若没有 .gitignore 则在根目录新建并写入该文件名。

---

4. 提交与推送

• Commit 语言：用英文。
• Commit 信息：简洁说明类型与内容，例如：
  • fix: rename garbled 4.1/4.2 filenames to correct Chinese and add changelog
  • docs: add changelog for section 4.1/4.2 filename fix
• Shell：Windows PowerShell 用 ; 连接命令，不用 &&。
• Push：仅当用户明确要求「上传」「push」时执行 git push；若用户说「不用上传」，则不要 add 改动说明（见上）、不要 push。

---

检查清单

• 修改已完成（含删除旧文件、更新链接若需要）
• 改动说明 MD 已写且为中文，按固定格式写清知识库添加了什么、内容概要、链接位置，且放在工程最外面（仓库根目录），如 改动说明-XXX.md
• 已按用户要求决定：改动说明随提交上传，或加入 .gitignore 不上传
• 已执行 git add（仅包含用户要提交的文件）
• Commit 信息为英文且清晰
• 仅在用户要求时执行 git push