docs: require manual updates to both repositories
This commit is contained in:
@@ -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 暂存差异。
|
||||||
|
- 模型、视频、音频、凭据和私钥不提交到本仓库。
|
||||||
@@ -49,3 +49,16 @@
|
|||||||
- `.gitattributes` 负责文本换行规范,不使用编码转换过滤器。
|
- `.gitattributes` 负责文本换行规范,不使用编码转换过滤器。
|
||||||
- `.gitignore` 排除媒体成片、模型权重、缓存、虚拟环境和密钥文件,保留 Markdown 与普通 JSON 检查记录。
|
- `.gitignore` 排除媒体成片、模型权重、缓存、虚拟环境和密钥文件,保留 Markdown 与普通 JSON 检查记录。
|
||||||
- 当前未添加 `LICENSE` 文件。
|
- 当前未添加 `LICENSE` 文件。
|
||||||
|
|
||||||
|
## GitHub 与 Gitea 手动同步
|
||||||
|
|
||||||
|
当前采用手动同步,每次更新手册或相关文档时,同时更新以下两个私有仓库:
|
||||||
|
|
||||||
|
- [GitHub / suanyuit-cyber/ai-series-comfyui-handbook](https://github.com/suanyuit-cyber/ai-series-comfyui-handbook)
|
||||||
|
- [Gitea / qishizhe/ai-series-comfyui-handbook](https://git.lain.asia/qishizhe/ai-series-comfyui-handbook)
|
||||||
|
|
||||||
|
在本地 `main` 完成文档修改和检查后,提交并推送到 GitHub,再将同一版本的变更同步到 Gitea。Gitea 命令行没有可用凭据时,通过已登录的网页编辑或上传文件。
|
||||||
|
|
||||||
|
交付前核对两边文件列表与内容;可导出 Gitea 的 Git Bundle,与 GitHub 的 Git 文件树比较。两边保留各自的提交历史,提交 SHA 可以不同,最终文件树应一致。
|
||||||
|
|
||||||
|
自动同步目前未启用。此前准备的配置保存在本地 `draft/github-gitea-sync` 草稿分支,后续是否启用由用户另行决定。具体维护要求见 [AGENTS.md](AGENTS.md)。
|
||||||
|
|||||||
Reference in New Issue
Block a user