文档: 补充第 5 条发布约定——发布说明从简,详情记入本地 CHANGELOG

- AGENTS.md「硬性规则」由四条扩为五条,新增:Release 正文只列"更新了哪几点"
  (每条一行,不写根因/证据/验证过程),详细信息统一记入本地记录
  /home/zijun/dsh_data/maidongktv/CHANGELOG.md(工作区根目录、仓库之外,
  既不随 Release 发布也不提交进 Gitea),并给出 Release 正文的推荐格式示例。
- 明确分工: CHANGELOG.md = 每个版本"发生了什么"; AGENTS.md = 以后改代码"必须遵守什么"。
- 本地 CHANGELOG.md 已建立(含 1.4.2 ~ 1.5.5 的根因、证据、验证与发布信息,按版本倒序)。
This commit is contained in:
zijunchiang
2026-10-07 17:29:23 +08:00
parent 97ca1ae28e
commit 39e3c8d617
+22 -1
View File
@@ -11,7 +11,7 @@
| `origin` | `https://gitea.kasugano.cn/zijunchiang/maidong-ktv.git` | ✅ 代码主仓库,**唯一的代码同步目标** | | `origin` | `https://gitea.kasugano.cn/zijunchiang/maidong-ktv.git` | ✅ 代码主仓库,**唯一的代码同步目标** |
| `gitee` | `https://gitee.com/zijunchiang/maidong-ktv.git` | 📦 **不推代码**,只用于发布 Release;仓库内只保留 README 文档 + Releases 附件 | | `gitee` | `https://gitee.com/zijunchiang/maidong-ktv.git` | 📦 **不推代码**,只用于发布 Release;仓库内只保留 README 文档 + Releases 附件 |
### 四条硬性规则 ### 五条硬性规则
1. **推送失败只重试 3 次**:Gitea 不可用(网络不通/服务器故障/返回非 200)时,最多重试 **3 次** 1. **推送失败只重试 3 次**:Gitea 不可用(网络不通/服务器故障/返回非 200)时,最多重试 **3 次**
(间隔约 60s)。3 次仍失败就**停止重试**,改动保留为本地 commit,**留到下次一起同步** (间隔约 60s)。3 次仍失败就**停止重试**,改动保留为本地 commit,**留到下次一起同步**
@@ -36,6 +36,27 @@
> 三者的触发条件只有一个 —— **收到明确的人工发布指令**。若不确定是否已发布, > 三者的触发条件只有一个 —— **收到明确的人工发布指令**。若不确定是否已发布,
> 用 `GET /repos/{owner}/{repo}/releases` 与 `/tags` 核对,不要凭"打过包"推断。 > 用 `GET /repos/{owner}/{repo}/releases` 与 `/tags` 核对,不要凭"打过包"推断。
5. **发布说明从简,详情留本地(2026-10 新增)**:Release 正文**只列"更新了哪几点"**——
每条一行,写清"改了什么 / 用户能感知到什么";**不写**根因分析、不贴证据与 URL、
不写验证过程、不列日志片段。**详细信息写在本地记录**
`/home/zijun/dsh_data/maidongktv/CHANGELOG.md`
(工作区根目录、**仓库之外**:既不随 Release 发布,也不提交进 Gitea)。
两者分工:
- **CHANGELOG.md** = 每个版本"发生了什么"(根因/证据/验证/发布信息,按版本倒序);
- **AGENTS.md** = 以后改代码"必须遵守什么"(约定与坑位),不重复 CHANGELOG 的过程叙述。
Release 正文推荐格式(示例):
```
## 麦动KTV V1.5.5
- 新增歌曲源 a.ktv8.my
- 歌曲源全部失效时提示「远程源已全部失效,等待新版本修复」
- 修复:点歌失败后歌曲不出现在下载列表
- 下载列表支持删除(有文件的删文件,失败任务移出列表)
```
> 每次发布/打包后,把该版本写进 CHANGELOG.md(含 `versionCode`、md5、发布位置与校验结果),
> 这样 Release 保持简短、`git log` 保持可读,而"为什么这么改"永远查得到。
- 凭据: - 凭据:
- **Gitea**(代码主仓库):访问令牌 `dsh-sync-20260926`(2026-09-26 数据迁移后重建;可在 Gitea - **Gitea**(代码主仓库):访问令牌 `dsh-sync-20260926`(2026-09-26 数据迁移后重建;可在 Gitea
「设置 → 应用 → 访问令牌」随时吊销),存放于 `~/.git-credentials-gitea`(权限 600), 「设置 → 应用 → 访问令牌」随时吊销),存放于 `~/.git-credentials-gitea`(权限 600),