mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-11-05 16:57:32 +00:00
## 为什么
规划/设计在交接前会反复改。入库后有两个实际问题:
· 每改一次就是一条"改文档"提交,把真实代码提交埋掉
· 规划与实现必然漂移,读了仓库里的人会拿到过期结论
## 既有惯例
本仓早就是这样处理的,不是新立的规矩:
/plan.md 曾在 7901651「移除过程文档」被清出
/kernelplan.md 从未入库
两者都在 .gitignore 里,都只存在于工作区
## 做法
· docs/zh/dshplgadapter-plan.md 从索引移除(文件本身留在工作区)
· 挪到仓库根 dshplgadapter-plan.md,与 plan.md / kernelplan.md 同位置
· .gitignore 加 /dshplgadapter-plan.md,并写明理由
实现落地后,结论会进 docs/zh/ 下的正式设计文档 —— 那里才是该留档的地方。
## 影响
内核仓历史里 e8d07cd、82d08eb 两个提交只含这份规划书,现已从工作树移除。
如需追查当时的结论,git show e8d07cd 仍可读到(历史不重写)。
144 lines
4.8 KiB
Plaintext
144 lines
4.8 KiB
Plaintext
/homed
|
||
/waiter
|
||
*.exe
|
||
*.log
|
||
*.test
|
||
build/
|
||
*.so
|
||
*.db
|
||
data/
|
||
.tmp-plugins/
|
||
.go/
|
||
.local/
|
||
|
||
*.hmap
|
||
dev/
|
||
|
||
login.json
|
||
|
||
# GUI
|
||
cmd/gui/node_modules/
|
||
cmd/gui/dist/
|
||
|
||
.gopath/
|
||
|
||
# SDK 工具链 — 核心仓不追踪
|
||
#
|
||
# 外部插件与工具链维护在独立 SDK 仓(决策 sdk_repo_only),
|
||
# 本仓经 go.mod 的 replace => ./third_party/hologramagentsdk 引用。
|
||
# example/ 下已跟踪的 21 个文件(10 个示例的 plg.json + plugin.go,
|
||
# 加 qq/plugin_test.go)早于本规则,
|
||
# 靠「已跟踪文件不受 .gitignore 影响」保留——这是有意的,不要「修」。
|
||
third_party/hologramagentsdk/bin/
|
||
third_party/hologramagentsdk/tools/
|
||
third_party/hologramagentsdk/package/
|
||
third_party/hologramagentsdk/scripts/
|
||
# skills/ 是 SDK 仓的 skill 源(hmapdev skill install 的来源),
|
||
# 与 tools/、docs/ 同理属 SDK 仓自治范围,不进本仓。
|
||
third_party/hologramagentsdk/skills/
|
||
# .github/ 同理:SDK 仓的 workflow 由 SDK 仓自己管(它在那边被跟踪),
|
||
# 本仓不参与构建,不需要在这边重复一份。
|
||
third_party/hologramagentsdk/.github/
|
||
third_party/hologramagentsdk/.gitignore
|
||
third_party/hologramagentsdk/README*
|
||
third_party/hologramagentsdk/example/
|
||
# 文档站(mkdocs.yml + docs/ + 生成器)属于 SDK 仓,与 README* / tools/ 同理。
|
||
# 注意 docs/ 带前导路径限定,够精确:本仓自己的 docs/ 不受影响。
|
||
third_party/hologramagentsdk/docs/
|
||
third_party/hologramagentsdk/mkdocs.yml
|
||
third_party/hologramagentsdk/site_build/
|
||
# 主题覆盖目录(只覆盖 footer.html,补备案号)——同属文档站。
|
||
third_party/hologramagentsdk/overrides/
|
||
.codegraph/
|
||
|
||
# codegraph 本地索引配置(含嵌套 SDK 仓放行,仅本地生效)
|
||
codegraph.json
|
||
|
||
# 运行时产物(不提交)
|
||
#
|
||
# ⚠️ 这些必须带前导斜杠。不带斜杠的模式(如 `memory/`)会匹配**任意层级**的
|
||
# 同名目录,把 internal/memory/、internal/knowledge/、deploy/scripts/ 一起吞掉
|
||
# ——24 + 3 + 1 个已跟踪源码文件曾因此落在 ignore 规则下,只靠「已跟踪
|
||
# 文件不受 .gitignore 影响」这条 git 规则兜着,新增文件会默默不入库。
|
||
/adapters/
|
||
/knowledge/
|
||
/memory/
|
||
# 注:/scripts/ **不**忽略。它是作者维护的工具目录(模型导出、侧车、部署校验),
|
||
# 不是运行期产物:deploy/systemd/embed-sidecar.service 直接引用
|
||
# scripts/embed_sidecar.py,忽略它会让那份 unit 在别人的机器上指向不存在的文件。
|
||
# 只忽略其中的缓存。
|
||
/scripts/__pycache__/
|
||
__pycache__/
|
||
terminal_locked_log.txt
|
||
|
||
dist/
|
||
.pi-glla/
|
||
.omo/
|
||
.pi/
|
||
|
||
# HarmonyOS 构建工具链缓存(HVIGOR_USER_HOME / ohpm 生成,非源码)
|
||
.hvigor-home/
|
||
.npm-cache/
|
||
.ohpm/
|
||
|
||
# 漂移巡检的运行时状态(含时间戳与指纹,每次跑都变)
|
||
.drift-watch/
|
||
|
||
# ——— 本地运维脚本 / 一次性工具(不入库,克隆后需另行获取)———
|
||
# deploy-*.sh 是生产部署入口,含环境相关的 IP/路径约定;
|
||
# 文档见 docs/zh/deploy-runbook.md。换机器部署前先确认脚本来源。
|
||
/deploy-plan.sh
|
||
/deploy-waiter.sh
|
||
/deploy-sdk-site.sh
|
||
|
||
# 一次性跑分/设计提取脚本,用完即弃
|
||
/tmp_jinabench.py
|
||
/napcat-design-dna.json
|
||
|
||
# 已删除的动态工作文档(2e30e06)。曾被本机某进程恢复过一次 ——
|
||
# 它的 mtime 还是删除前的 Sep 26,说明是外部写回而不是 git 操作。
|
||
# 不加这行的话,恢复一次就重新入库一次。
|
||
/plan.md
|
||
|
||
# 临时探针目录(scripts/ 之外的临时 main.go 探针)
|
||
/tools/zz_*/
|
||
|
||
# 编译产物(迁移工具)
|
||
/homed-graph-migrate
|
||
|
||
# 构建产物落在仓库根(go build ./cmd/xxx 时最易发生)
|
||
/homed
|
||
/homed-graph-migrate
|
||
/homed-graph-distill
|
||
/homed-centroid
|
||
|
||
# ── 本机运维脚本(含 /home/newqqagent 等本机路径与凭据搬运逻辑,不进仓库)──
|
||
/deploy/scripts/deploy.sh
|
||
/scripts/verify_deploy.sh
|
||
/scripts/kernel-stress/
|
||
/scripts/gui-package-smoke.sh
|
||
|
||
# ── 本地 AI 工具的仓库级配置(每人偏好不同,不进仓库)──
|
||
.pi-lens.json
|
||
|
||
# agent 会话附件(本地产物,不进版本库)
|
||
.pi-web/
|
||
|
||
# ── 内置 pi 的会话日志(agent 工作产物,不进仓库)──
|
||
/.pi-sessions/
|
||
|
||
# ── 本地 NLP 模型权重(48MB ONNX,本机推理用,不进仓库)──
|
||
# 有意不提交:二进制大文件会永久留在 git 历史里,且需与本机 nlp 加载路径配套。
|
||
# 需要时由部署脚本/人工放置到该目录。
|
||
/nlp/
|
||
|
||
# 内核升级 CLI 的本地构建产物(与 /homed 同理,不入库)
|
||
/homed-upgrade
|
||
/kernelplan.md
|
||
|
||
# dshplgadapter 规划书(工作文档,不进仓库)
|
||
# 与 /plan.md、/kernelplan.md 同一惯例:规划/设计在交接前会反复改,
|
||
# 入库后要么产生一堆"改文档"提交,要么与实际实现漂移。
|
||
# 实际实现落地时,结论会进 docs/zh/ 下的正式设计文档。
|
||
/dshplgadapter-plan.md
|