get-shit-done 在敏感项目中如何设置 commit_docs 为 false 让 .planning/ 只留在本地【免费下载链接】get-shit-doneA light-weight and powerful meta-prompting, context engineering and spec-driven development system for Claude Code by TÂCHES.项目地址: https://gitcode.com/GitHub_Trending/getshi/get-shit-done用 get-shit-doneGSD做项目时/gsd-new-project、plan-phase、execute-phase等工作流会在项目根目录下生成.planning/目录其中包含ROADMAP.md、STATE.md、SUMMARY.md以及各阶段的规划文档。这些文件默认会被提交到 git配置项commit_docs默认值为true。如果你在客户项目、外部贡献仓库等敏感环境中工作不想让规划决策的完整历史进入版本库就需要关闭commit_docs让.planning/只留在本地工作区。本文基于 docs/CONFIGURATION.md 的 Private Planning Setup 章节、docs/USER-GUIDE.md 的 Working on a Sensitive/Private Project 章节以及 get-shit-done/references/planning-config.md、get-shit-done/references/git-planning-commit.md 的参考文档给出完整的设置路径和验证方式。前提条件已在当前项目中运行过 GSD项目根目录下存在.planning/目录和.planning/config.json。根据 docs/CONFIGURATION.mdGSD 的项目设置存放在.planning/config.json由/gsd-new-project创建、由/gsd-settings更新。当前目录是一个 git 仓库。本方案的核心是让 git 不再跟踪.planning/所以非 git 目录不涉及此配置。设置 commit_docs 为 false有两种设置入口任选其一。方式一通过 GSD 命令设置在运行/gsd-new-project时设置commit_docs: false或者对已有项目使用/gsd-settings修改。docs/USER-GUIDE.md 对敏感/私有项目的建议原文是Setcommit_docs: falseduring/gsd-new-projector via/gsd-settings. Add.planning/to your.gitignore. Planning artifacts stay local and never touch git.方式二直接编辑 .planning/config.jsoncommit_docs可以写在顶层也可以写在planning命名空间下。get-shit-done/references/planning-config.md 明确说明planning.commit_docs与顶层commit_docs等价如果两者同时存在顶层值优先。按非提交模式uncommitted mode的官方设置步骤在.planning/config.json中配置{ planning: { commit_docs: false, search_gitignored: true } }两个键的作用引自 docs/CONFIGURATION.md 的 Planning Settings 表planning.commit_docsboolean默认true.planning/文件是否提交到 git。planning.search_gitignoredboolean默认false为宽泛的rg搜索添加--no-ignore使被 gitignore 的.planning/也能被搜到。.planning/进入.gitignore后把此项设为true可以保持 GSD 的搜索行为可用文档同时指出大多数 GSD 操作使用直接读文件或显式路径不受 gitignore 状态影响。把 .planning/ 加入 .gitignore在仓库根目录的.gitignore中追加一行.planning/这一步不只是建议而是文档要求的配套动作。get-shit-done/references/planning-config.md 在commit_docs: false的行为说明中写明用户必须把.planning/加入.gitignore。另外文档定义了一条自动检测规则值得注意即使config.json里写着true只要.planning/出现在.gitignore中commit_docs会自动按false处理以避免产生 git 错误反过来config.json 中显式设置的值总是覆盖自动检测get-shit-done/references/planning-config.md Field Interactions。处理已被 git 跟踪的 .planning/ 文件如果.planning/在设置之前已经被提交过仅加入.gitignore不会让 git 停止跟踪它。此时按文档给出的步骤执行git rm -r --cached .planning/ git commit -m chore: stop tracking planning docs副作用说明git rm -r --cached只把文件从 git 索引中移除不会删除本地工作区的任何文件随后必须用一次git commit固化停止跟踪这个变更。这个 commit 本身会进入历史但.planning/文件内容自此不再随后续提交变化。验证设置是否生效文档给出两个可用的核对方式。用 gsd-sdk commit 命令观察跳过行为GSD 通过gsd-sdk query commit提交.planning/文件该命令会自动检查commit_docs配置和 gitignore 状态。get-shit-done/references/git-planning-commit.md 说明当commit_docs为false或.planning/被 gitignore 时CLI 返回skipped附带原因不需要手动写条件判断。可以跑一次确认gsd-sdk query commit docs({scope}): {description} --files .planning/STATE.md命令中的提交信息按文档模板替换为你自己的 scope 与描述--files后跟要提交的路径。设置生效后预期输出为skipped并给出原因而不是产生新的 commit。用 git status 核对 .planning/ 状态同一份参考文档列出提交前的检查项之一git status --porcelain .planning/在commit_docs: false且.planning/已加入.gitignore的配置下GSD 会跳过所有针对.planning/文件的git add/git commit该命令可用于确认.planning/下没有处于待提交状态的变化。使用分支策略时的一个补充说明如果你的项目使用git.branching_strategy: phase或milestoneget-shit-done/references/planning-config.md 说明当commit_docs: false时complete-milestone工作流会在 merge commit 之前自动把.planning/文件从暂存区剥离。也就是说分支合并路径上同样不需要手动清理。边界与限制commit_docs: false只影响.planning/规划文档的提交行为不影响代码、文档等正常提交。配置键支持顶层commit_docs与planning.commit_docs两种写法两者等价顶层优先改配置后两种位置只保留一处避免歧义。如果只想让搜索也跳过.planning/保持默认search_gitignored: false则直接路径搜索rg pattern .planning/仍然有效仅宽泛的全仓搜索会跳过该目录——这是 get-shit-done/references/planning-config.md 中 Search Behavior 小节描述的行为。完成以上设置后.planning/中的规划文件只存在于本地工作区gsd-sdk query commit对它们返回skipped.planning/不再出现在待提交列表中规划文档的完整历史便不会进入 git。【免费下载链接】get-shit-doneA light-weight and powerful meta-prompting, context engineering and spec-driven development system for Claude Code by TÂCHES.项目地址: https://gitcode.com/GitHub_Trending/getshi/get-shit-done创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考