mirror of
https://gitcode.com/JianFeeeee/HomeAgent.git
synced 2026-11-06 17:27:31 +00:00
chore: 规划书不进仓库(与 plan.md / kernelplan.md 同惯例)
## 为什么
规划/设计在交接前会反复改。入库后有两个实际问题:
· 每改一次就是一条"改文档"提交,把真实代码提交埋掉
· 规划与实现必然漂移,读了仓库里的人会拿到过期结论
## 既有惯例
本仓早就是这样处理的,不是新立的规矩:
/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 仍可读到(历史不重写)。
This commit is contained in:
6
.gitignore
vendored
6
.gitignore
vendored
@ -135,3 +135,9 @@ dist/
|
||||
# 内核升级 CLI 的本地构建产物(与 /homed 同理,不入库)
|
||||
/homed-upgrade
|
||||
/kernelplan.md
|
||||
|
||||
# dshplgadapter 规划书(工作文档,不进仓库)
|
||||
# 与 /plan.md、/kernelplan.md 同一惯例:规划/设计在交接前会反复改,
|
||||
# 入库后要么产生一堆"改文档"提交,要么与实际实现漂移。
|
||||
# 实际实现落地时,结论会进 docs/zh/ 下的正式设计文档。
|
||||
/dshplgadapter-plan.md
|
||||
|
||||
Reference in New Issue
Block a user