mirror of
https://github.com/codestable/CodeStable.git
synced 2026-09-19 09:03:09 +08:00
4.0 KiB
4.0 KiB
Claude Rules
核心原则
言简意赅。先读仓库事实、现有 skill 文档和 ADR,再修改规则;只把可复用且能验证的做法写进规则文件。
语言与文档
- 默认用中文写面向人的回复、报告和文档;代码、命令、路径、协议字段、YAML/JSON key 保持原格式。
- 单个 Markdown 文件不得超过 300 行;超过必须拆分。
- 增加或更新 skill 时,同步检查相关 skill、README/reference、测试和 ADR 中的表述。
AGENTS.md/CLAUDE.md只写 agent 行为规则;不要替代.codestable/attention.md、项目文档、work 文档或 ADR 等项目事实载体。
Skill 边界
- 不同 skill 之间不要相互耦合;A skill 在非必须情况下不要读取或依赖 B skill 的内部文件。
- skill 是独立安装单元,运行时每个 skill 只能稳定看到自己包内文件;不要在 SKILL.md 中写
B-skill/reference/xxx.md这类 sibling 引用。 - v2 基础骨架只预建
.codestable/attention.md、lessons/与work/;永久 Epic 优先沿用项目既有 Epic/RFC/initiative 归宿,否则首次创建时才按需建立.codestable/epics/,onboard 不预建空目录。 - v1 的
.codestable/roadmap/、.codestable/features/、.codestable/issues/、.codestable/refactors/、.codestable/goals/、.codestable/compound/、.codestable/audits/、.codestable/brainstorms/与.codestable/feedback/只作只读历史知识源:四个 owning task skills(cs-feat、cs-issue、cs-refactor、cs-epic)按任务关键词覆盖全部九目录并引用命中路径;其他 skill 仅检索自身契约明确点名的历史源。不得继续生成、原地改写或批量迁移。 .codestable/requirements/仅在.codestable/attention.md明确记录其为 canonical requirement 位置时才可维护;owner 首次指定时先写入 attention,未记录时按只读历史知识处理且不得默认创建。- skill 专属 context 和确定性 helper 分别放在 owning skill 的
references/与scripts/;跨 skill 通用规则应归宿主策略、项目事实或独立安装单元。
Epic 生命周期
- 永久 Epic 文档是目标、范围、非目标、验收、已批准子项、关键决策、最终交付、整体验收、遗留风险和长期状态的唯一 owner;
.codestable/work/epic-{slug}.md只是临时执行游标,只写永久文档指针、批准 revision、phase、子项进度、下一步、阻塞、item_progression、milestone_commit、remote_publish和证据,不复制稳定契约或最终结论。 - 保留三道 owner gate:fresh design review 后确认拆解;目标、边界、验收、子项定义或重大风险变化时重新 review 并确认;全部子项完成后由 fresh reviewer 对最新 owner 已批准的验收标准做 final acceptance review,再由 owner 最终接受。
- 普通子项完成不是 owner gate:
continuous策略下串行自动推进下一项,不询问是否继续或终态返回;只有显式per-item策略、owning-skill 门槛、真实阻塞、新权限或最终验收才暂停。 - Epic 进入
accepted、superseded或cancelled终态后保留永久文档,幂等清理临时 Epic/子项 work;不恢复cs-goal入口、goal package、state.yaml、逐轮 iteration 报告或 legacy runtime gate。
v1 兼容边界
- v1 的
.codestable/reference/、tools/、gates/、hooks/、runtime-manifest.json原样保留,但 v2 skill 不把它们作为入口或执行其中的 legacy runtime。 - 不要新增、同步或刷新 repo-local CodeStable runtime;确定性行为由 owning skill 自己的 helper 或项目已有工具负责。
- CodeStable skills 不拥有默认 worktree/branch 策略;是否创建 worktree、如何命名分支、如何 merge,应由宿主、owner 或未来独立 skill 决定。
验证
- skill/runtime 改动完成前至少运行相关 pytest 与
git diff --check。 - plugin 分发或退役清单变更还要运行
tests/test_skills_cli_distribution.py与tools/check-plugin-package.py。