docs: require manual updates to both repositories

This commit is contained in:
2026-10-29 01:33:39 +08:00
parent d74f03ad3b
commit 5c8ee3380f
2 changed files with 31 additions and 0 deletions
+18
View File
@@ -0,0 +1,18 @@
# 本仓库协作约定
## 手册更新必须手动同步两边
用户于 2026-10-29 明确要求:先手动同步,以后更新手册时,GitHub 和 Gitea 两边一起更新。
- 本地在 `main` 上整理和检查文档。发布目标为 GitHub 的 `suanyuit-cyber/ai-series-comfyui-handbook` 和 Gitea 的 `qishizhe/ai-series-comfyui-handbook`(`https://git.lain.asia`)。本地远程名分别为 `origin` 和 `gitea`。
- 每次修改主手册、研究笔记、README 或其他仓库文档,都要在交付前同步到两个仓库,并检查目标文件及内容一致。
- 两边初始提交历史不同,允许提交 SHA 不同;以同一文档版本和最终 Git 文件树一致为验收依据。不要为对齐 SHA 而强制推送、删除或重建仓库。
- GitHub 可通过现有 Git 凭据推送;Gitea 命令行无凭据时,使用用户已登录的网页编辑或上传本次文件。需要比对时,可下载 Gitea 的 Git Bundle,在本地与 GitHub 文件树检查差异。
- 保持当前手动同步方式。用户未再次明确授权前,不启用自动同步工作流,不添加部署密钥、Actions secret 或账号令牌。
- 如果某一端因登录、网络或权限问题未更新,明确报告已完成的一端和未完成的一端;不要将单边成功表述为双边同步完成。
## 文档维护
- 主手册修改后,按实际结果更新 `文档检查记录.json`;仅修改仓库说明时,不改写主手册的原有内容校验结果。
- 文本保存为 UTF-8、LF,检查 Markdown 相对链接和 Git 暂存差异。
- 模型、视频、音频、凭据和私钥不提交到本仓库。