cc-devflow 4.5.0 → 4.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/.claude/skills/cc-plan/CHANGELOG.md +14 -0
  2. package/.claude/skills/cc-plan/PLAYBOOK.md +19 -2
  3. package/.claude/skills/cc-plan/SKILL.md +52 -20
  4. package/.claude/skills/cc-plan/assets/DESIGN_TEMPLATE.md +70 -1
  5. package/.claude/skills/cc-plan/assets/TASKS_TEMPLATE.md +13 -0
  6. package/.claude/skills/cc-plan/assets/TASK_MANIFEST_TEMPLATE.json +3 -1
  7. package/.claude/skills/cc-plan/assets/TINY_DESIGN_TEMPLATE.md +22 -0
  8. package/.claude/skills/cc-roadmap/CHANGELOG.md +12 -0
  9. package/.claude/skills/cc-roadmap/PLAYBOOK.md +24 -1
  10. package/.claude/skills/cc-roadmap/SKILL.md +50 -15
  11. package/.claude/skills/cc-roadmap/assets/BACKLOG_TEMPLATE.md +15 -0
  12. package/.claude/skills/cc-roadmap/assets/ROADMAP_TEMPLATE.md +37 -0
  13. package/.claude/skills/cc-roadmap/assets/TRACKING_TEMPLATE.json +2 -1
  14. package/CHANGELOG.md +20 -0
  15. package/CODE_OF_CONDUCT.md +39 -0
  16. package/CODE_OF_CONDUCT.zh-CN.md +39 -0
  17. package/CONTRIBUTING.md +195 -0
  18. package/CONTRIBUTING.zh-CN.md +195 -0
  19. package/README.md +141 -150
  20. package/README.zh-CN.md +144 -148
  21. package/SECURITY.md +56 -0
  22. package/SECURITY.zh-CN.md +56 -0
  23. package/docs/examples/example-bindings.json +3 -3
  24. package/docs/examples/full-design-blocked/BACKLOG.md +1 -1
  25. package/docs/examples/full-design-blocked/README.md +1 -1
  26. package/docs/examples/full-design-blocked/ROADMAP.md +1 -1
  27. package/docs/examples/full-design-blocked/changes/REQ-002-bulk-invite-import/planning/design.md +1 -1
  28. package/docs/examples/full-design-blocked/changes/REQ-002-bulk-invite-import/planning/tasks.md +1 -1
  29. package/docs/examples/full-design-blocked/roadmap-tracking.json +1 -1
  30. package/docs/examples/local-handoff/BACKLOG.md +1 -1
  31. package/docs/examples/local-handoff/README.md +1 -1
  32. package/docs/examples/local-handoff/ROADMAP.md +1 -1
  33. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/planning/design.md +1 -1
  34. package/docs/examples/local-handoff/changes/REQ-003-audit-log-export/planning/tasks.md +1 -1
  35. package/docs/examples/local-handoff/roadmap-tracking.json +1 -1
  36. package/docs/examples/pdca-loop/BACKLOG.md +1 -1
  37. package/docs/examples/pdca-loop/README.md +1 -1
  38. package/docs/examples/pdca-loop/ROADMAP.md +1 -1
  39. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/planning/design.md +1 -1
  40. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/planning/task-manifest.json +2 -2
  41. package/docs/examples/pdca-loop/changes/REQ-001-copy-invite-link/planning/tasks.md +1 -1
  42. package/docs/examples/pdca-loop/roadmap-tracking.json +1 -1
  43. package/docs/guides/getting-started.md +5 -0
  44. package/docs/guides/getting-started.zh-CN.md +5 -0
  45. package/package.json +7 -1
@@ -0,0 +1,195 @@
1
+ # 为 cc-devflow 做贡献
2
+
3
+ [中文版](./CONTRIBUTING.zh-CN.md) | [English](./CONTRIBUTING.md)
4
+
5
+ ---
6
+
7
+ 请同时阅读 [行为准则](./CODE_OF_CONDUCT.zh-CN.md)。如果你要报告漏洞,请遵循 [安全策略](./SECURITY.zh-CN.md),不要创建公开 issue。
8
+
9
+ ## 概览
10
+
11
+ cc-devflow 现在是一个 skills-first 仓库,并且重新带回了可分发的 CLI。
12
+
13
+ 对外可见面只有这些:
14
+
15
+ - `cc-roadmap`
16
+ - `cc-plan`
17
+ - `cc-investigate`
18
+ - `cc-do`
19
+ - `cc-check`
20
+ - `cc-act`
21
+ - `cc-devflow init`
22
+ - `cc-devflow adapt`
23
+
24
+ `lib/skill-runtime/` 可以保留共享运行时支撑,但它已经不是用户要直接理解或运行的工作流入口。
25
+
26
+ 仓库里也可以存在维护类 Skill,例如 `cc-spec-init`、`cc-simplify`、`docs-sync`,但它们不改变公开的 `cc-roadmap + PDCA/IDCA` 叙事。
27
+
28
+ ---
29
+
30
+ ## 开发环境
31
+
32
+ ### 前置条件
33
+
34
+ - Node.js 18+
35
+ - npm
36
+ - Git
37
+
38
+ ### 安装
39
+
40
+ ```bash
41
+ git clone https://github.com/YOUR_USERNAME/cc-devflow.git
42
+ cd cc-devflow
43
+ npm install
44
+ ```
45
+
46
+ ### 本地 CLI 冒烟验证
47
+
48
+ 如果你在源码仓库里开发,请使用仓库内入口:
49
+
50
+ ```bash
51
+ node bin/cc-devflow-cli.js --help
52
+ tmpdir=$(mktemp -d)
53
+ node bin/cc-devflow-cli.js init --dir "$tmpdir"
54
+ node bin/cc-devflow-cli.js adapt --cwd "$tmpdir" --platform codex
55
+ rm -rf "$tmpdir"
56
+ ```
57
+
58
+ 如果要验证打包后的行为,运行:
59
+
60
+ ```bash
61
+ npm pack
62
+ node scripts/validate-publish.js
63
+ ```
64
+
65
+ ---
66
+
67
+ ## 项目结构
68
+
69
+ ```text
70
+ cc-devflow/
71
+ ├── .claude/skills/ # 对外分发的 Skill
72
+ ├── bin/ # CLI 入口
73
+ ├── config/ # Adapter 配置
74
+ ├── docs/ # 公开文档
75
+ ├── lib/adapters/ # 平台适配层
76
+ ├── lib/compiler/ # 多平台编译器
77
+ ├── lib/skill-runtime/ # 供 Skill 脚本复用的共享运行时与同目录测试
78
+ ├── README.md
79
+ ├── README.zh-CN.md
80
+ └── package.json
81
+ ```
82
+
83
+ ### 常见贡献区域
84
+
85
+ - `.claude/skills/`:Skill 行为、资源、引用、脚本
86
+ - `bin/`:可分发 CLI 行为
87
+ - `lib/compiler/`:skills/prompts 解析、转换、emitters、rules 生成
88
+ - `lib/adapters/`:平台 adapter 配置与校验
89
+ - `lib/skill-runtime/`:Skill 脚本复用的共享运行时支撑
90
+ - `docs/`:对外文档
91
+
92
+ ---
93
+
94
+ ## 贡献规则
95
+
96
+ ### 1. 保持对外入口极简
97
+
98
+ 不要再把旧 `/flow:*` 或 `harness:*` CLI 写回新的用户文档。
99
+
100
+ 对外故事应该始终保持为:
101
+
102
+ - 整包安装:`cc-devflow init`
103
+ - 平台产物:`cc-devflow adapt`
104
+ - 工作流执行:`cc-roadmap + PDCA/IDCA` 可见 Skill
105
+ - capability 真相维护:`cc-spec-init`
106
+
107
+ ### 2. 保持 Skills-First 结构
108
+
109
+ 每个已发布 Skill 都应保持独立目录:
110
+
111
+ ```text
112
+ .claude/skills/<skill>/
113
+ ├── SKILL.md
114
+ ├── PLAYBOOK.md
115
+ ├── assets/
116
+ ├── references/
117
+ └── scripts/
118
+ ```
119
+
120
+ 如果你改了一个已发布 Skill,要把这些文件当成同一个契约:
121
+
122
+ - `SKILL.md`
123
+ - 本地 `CHANGELOG.md`
124
+ - 被引用的 `PLAYBOOK.md`、`assets/`、`references/`、`scripts/`
125
+
126
+ 不要只改其中一部分,让其余说明继续过期。
127
+
128
+ ### 3. 保持分发包干净
129
+
130
+ 不要把瞬态文件放进模板或 tarball。
131
+
132
+ 典型脏文件包括:
133
+
134
+ - `.claude/tsc-cache/`
135
+ - `.DS_Store`
136
+ - 本地编辑器和操作系统产生的垃圾文件
137
+
138
+ ### 4. 让运行时辅助层保持次要
139
+
140
+ 如果你改了 `lib/skill-runtime/`,请保持可测试,但不要再把它写成用户主入口。真正的公开 workflow 仍然属于已发布 Skill。
141
+
142
+ ---
143
+
144
+ ## 测试
145
+
146
+ ### 主测试命令
147
+
148
+ ```bash
149
+ npm test
150
+ ```
151
+
152
+ ### CLI 回归测试
153
+
154
+ ```bash
155
+ npm test -- --runInBand lib/skill-runtime/__tests__/cli-bootstrap.integration.test.js
156
+ ```
157
+
158
+ ### 发布校验
159
+
160
+ ```bash
161
+ node scripts/validate-publish.js
162
+ ```
163
+
164
+ 它应该保证:
165
+
166
+ - CLI 必需文件存在
167
+ - 关键 Skill 存在
168
+ - 打包 tarball 干净
169
+ - 瞬态缓存不会被分发
170
+
171
+ ---
172
+
173
+ ## 文档规则
174
+
175
+ - README 和快速开始默认写打包后 CLI 的用法
176
+ - 贡献者文档才写 `node bin/cc-devflow-cli.js ...`
177
+ - `skills.sh` 只作为单 Skill 分发路径来写
178
+ - 不要把 `.claude/commands/` 写成必需结构
179
+ - 不要把内部运行时辅助层写成受支持的公开工作流
180
+ - 如果改了已发布 Skill,在同一个 PR 里同步该 Skill 的 `version`、本地 `CHANGELOG.md` 和受影响的公开文档
181
+ - 主 workflow 仍然只讲 `cc-roadmap + PDCA/IDCA`;`cc-spec-init` / `cc-simplify` 等维护类 Skill 单独说明
182
+
183
+ ---
184
+
185
+ ## Pull Request
186
+
187
+ 这个仓库比较好的 PR,通常会干净地只做一类事:
188
+
189
+ - 改进某个 Skill
190
+ - 修复 CLI 分发行为
191
+ - 修复编译器 / 适配行为
192
+ - 清理陈旧文档
193
+ - 增加有针对性的回归测试
194
+
195
+ 如果改动触碰了公开入口,记得在同一个 PR 里同步文档。
package/README.md CHANGED
@@ -1,129 +1,111 @@
1
- # 🚀 cc-devflow
1
+ # cc-devflow
2
2
 
3
- > Roadmap plus PDCA and IDCA skills for agent coding
3
+ > Agent-first development workflow for roadmap, planning, investigation, implementation, verification, and shipping.
4
4
 
5
- CC-DevFlow is a stripped-down workflow for the agent coding era. It gives you one front-door planning skill, `cc-roadmap`, then lets each requirement enter one of two closed loops: the planning loop `cc-plan -> cc-do -> cc-check -> cc-act`, or the investigation loop `cc-investigate -> cc-do -> cc-check -> cc-act`.
5
+ [![GitHub stars](https://img.shields.io/github/stars/Dimon94/cc-devflow?style=social)](https://github.com/Dimon94/cc-devflow/stargazers)
6
+ [![npm version](https://img.shields.io/npm/v/cc-devflow.svg)](https://www.npmjs.com/package/cc-devflow)
7
+ [![Node.js >=18](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](./package.json)
8
+ [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
6
9
 
7
- [中文文档](./README.zh-CN.md) | [English](./README.md)
10
+ [中文文档](./README.zh-CN.md) | [English](./README.md) | [Getting Started](./docs/guides/getting-started.md) | [Contributing](./CONTRIBUTING.md) | [Security](./SECURITY.md)
8
11
 
9
- ---
10
-
11
- ## 🎯 One-Line Introduction
12
-
13
- CC-DevFlow exposes six visible skills:
14
-
15
- - `cc-roadmap`: build the project's mid and long-range roadmap
16
- - `cc-plan`: clarify a roadmap item, design it, and turn it into tasks
17
- - `cc-investigate`: freeze symptom, reproduction, root cause, and repair tasks before fixing a bug
18
- - `cc-do`: implement, resume, repair from investigation, and apply review feedback
19
- - `cc-check`: verify with evidence
20
- - `cc-act`: ship, sync docs, and feed the result into the next cycle
21
-
22
- ## ✨ Core Features
23
-
24
- - **Minimal visible surface**: one `cc-roadmap` skill plus two entry loops that share the same `cc-do -> cc-check -> cc-act` tail
25
- - **Multi-platform CLI restored**: `cc-devflow` is back as the distributable CLI for `.claude` installation plus multi-platform adaptation for Codex, Cursor, Qwen, and Antigravity
26
- - **skills.sh-compatible skill layout**: `.claude/skills/<skill>/SKILL.md` stays compatible with single-skill distribution on skills.sh
27
- - **Skill-local resources**: each skill carries its own templates, references, and scripts
28
- - **Explicit, not hidden**: no default context injection, read the files you actually need
29
- - **Task-template first**: keep `planning/tasks.md` and `task-manifest.json` as the execution backbone
30
- - **Skill pack first**: the repository distributes `.claude` skills, playbooks, and assets as one pack
31
- - **Evidence before done**: verification, doc sync, PR brief, and release note live at the end of the loop
32
- - **Roadmap-first**: decide medium-range direction once, then execute through PDCA or IDCA
33
-
34
- ## 🧠 Mental Model
12
+ CC-DevFlow is a small, explicit workflow system for agent coding. It gives an AI agent one roadmap entry point, then routes every change through either a feature loop or a bug-investigation loop before work can be called done.
35
13
 
36
14
  ```text
37
15
  cc-roadmap
38
16
 
39
- PDCA: cc-plan -> cc-do -> cc-check -> cc-act
17
+ PDCA: cc-plan -> cc-do -> cc-check -> cc-act
40
18
  IDCA: cc-investigate -> cc-do -> cc-check -> cc-act
41
19
  ```
42
20
 
43
- Use `cc-roadmap` to decide the next 1-3 stages of the product.
21
+ ## Why cc-devflow
44
22
 
45
- Use `cc-plan` when the next problem is scope, design, and task freezing.
23
+ - **Small public surface**: six visible workflow skills plus a CLI for installation and platform adaptation.
24
+ - **Evidence before done**: implementation must pass through verification proof before shipping or handoff.
25
+ - **Skill-first distribution**: the public contract lives in `.claude/skills/<skill>/SKILL.md` and `PLAYBOOK.md`, not in hidden runtime behavior.
26
+ - **Multi-platform output**: install once, then adapt for Codex, Cursor, Qwen, Antigravity, and related agent environments.
27
+ - **Durable project memory**: roadmap, specs, planning, review, and handoff artifacts stay in `devflow/`; temporary worker scratch stays outside durable truth.
46
28
 
47
- Use `cc-investigate` when the next problem is root cause, reproduction, and repair boundary.
29
+ ## Quick Start
48
30
 
49
- Both loops converge into the same `cc-do -> cc-check -> cc-act` tail.
31
+ Prerequisites:
50
32
 
51
- The visible state machine lives in the public skills themselves. The pack is intentionally skill-first: routing, reroutes, recovery, and evidence rules are described in `SKILL.md` and `PLAYBOOK.md`, while `lib/skill-runtime/` is limited to shared support code that those skills reuse.
33
+ - Node.js 18+
34
+ - npm or a compatible package runner
35
+ - A Git repository
36
+ - Claude Code or another supported agent environment
52
37
 
53
- ## 🚀 Install
38
+ Install the whole skill pack:
54
39
 
55
- The built-in CLI is back to the classic `init + adapt` model.
40
+ ```bash
41
+ npx cc-devflow@latest init --dir /path/to/your/project
42
+ ```
56
43
 
57
- For the packaged CLI, the default entry stays simple:
44
+ Generate platform outputs:
58
45
 
59
46
  ```bash
60
- npx cc-devflow init --dir /path/to/your/project
47
+ npx cc-devflow@latest adapt --cwd /path/to/your/project --platform codex
48
+ npx cc-devflow@latest adapt --cwd /path/to/your/project --platform cursor
49
+ npx cc-devflow@latest adapt --cwd /path/to/your/project --platform qwen
50
+ npx cc-devflow@latest adapt --cwd /path/to/your/project --platform antigravity
61
51
  ```
62
52
 
63
- After installation, the restored CLI supports both pack installation and multi-platform adaptation:
53
+ Refresh every supported platform output:
64
54
 
65
55
  ```bash
66
- npx cc-devflow init --dir /path/to/your/project
67
- npx cc-devflow init --dir /path/to/your/project --force
68
- npx cc-devflow adapt --cwd /path/to/your/project --platform codex
69
- npx cc-devflow adapt --cwd /path/to/your/project --platform cursor
70
- npx cc-devflow adapt --cwd /path/to/your/project --platform qwen
71
- npx cc-devflow adapt --cwd /path/to/your/project --platform antigravity
56
+ npx cc-devflow@latest adapt --cwd /path/to/your/project --all
72
57
  ```
73
58
 
74
- Whole-pack installation ships the six visible workflow skills plus the maintenance skills `cc-spec-init` and `cc-simplify`.
75
- `init --force` now force-upgrades only the managed distributed skills and preserves unrelated project files under `.claude`.
59
+ After installation, ask your agent to use the workflow skills directly. Start with `cc-roadmap` for product direction, use `cc-plan` for new work, use `cc-investigate` for bugs, then continue through `cc-do`, `cc-check`, and `cc-act`.
76
60
 
77
- If you are running from a source checkout instead of an installed package, use `node bin/cc-devflow-cli.js ...` or `npm exec -- cc-devflow ...`.
61
+ ## Workflow Skills
78
62
 
79
- ## ⚙️ Personal YAML Config
63
+ | Skill | Use it when | Main output |
64
+ | --- | --- | --- |
65
+ | `cc-roadmap` | You need product direction, staged scope, or backlog order | `devflow/ROADMAP.md`, `devflow/BACKLOG.md` |
66
+ | `cc-plan` | A feature or change needs scope, design, and task freezing | `planning/design.md`, `planning/tasks.md`, `task-manifest.json` |
67
+ | `cc-investigate` | A bug needs symptom, reproduction, root cause, and repair boundary | `planning/analysis.md`, `planning/tasks.md`, `task-manifest.json` |
68
+ | `cc-do` | Planned or investigated work needs implementation | code, tests, checkpoints, scratch runtime |
69
+ | `cc-check` | Work needs fresh verification evidence | `report-card.json` |
70
+ | `cc-act` | Verified work needs a PR, local handoff, release note, or closeout | one final handoff file |
80
71
 
81
- CC-DevFlow reads personal/project YAML config at runtime before durable workflow documents are written. Create one or more config files:
72
+ Maintenance skills are shipped with the pack:
82
73
 
83
- ```text
84
- ~/.cc-devflow/config.yml
85
- <repo>/.cc-devflow/config.yml
86
- <repo>/.cc-devflow/config.local.yml
87
- ```
74
+ - `cc-spec-init`: initialize and maintain durable capability specs under `devflow/specs/`
75
+ - `cc-simplify`: review changed code for reuse, quality, efficiency, and spec drift
88
76
 
89
- Precedence is deterministic: defaults < user < project < local < env < CLI. `output.document_language` is machine-enforced and currently supports only `en` and `zh-CN`. Non-standard user preferences belong under `agent_preferences`; they are advisory and never override workflow contracts.
77
+ ## Planning Quality Gates
90
78
 
91
- Example:
79
+ `cc-roadmap` now records planning posture and evidence maturity before recommending a route. That keeps idea-stage, active-user, paying-customer, infrastructure, and recovery work from being forced through the same questions. Developer-facing or operator-facing roadmap items also carry target user, time to first value, magic moment, and adoption bottleneck into `cc-plan`.
92
80
 
93
- ```yaml
94
- version: 1
95
- output:
96
- document_language: zh-CN
97
- agent_preferences:
98
- general:
99
- - Start with the conclusion.
100
- documentation:
101
- - Keep headings short and avoid marketing language.
102
- ```
81
+ `cc-plan` freezes more implementation decisions before `cc-do` starts. Non-trivial plans compare minimal viable and ideal architecture options, full designs include decision horizon plus error/rescue mapping, and test-first plans record test framework evidence, coverage quality, and mandatory regression tests when existing behavior changes.
103
82
 
104
- Create or edit config with:
83
+ ## Installation Modes
105
84
 
106
- ```bash
107
- npx cc-devflow config init --cwd /path/to/your/project --project
108
- npx cc-devflow config set output.document_language zh-CN --cwd /path/to/your/project --project
109
- npx cc-devflow config set output.document_language zh-CN --user
110
- ```
85
+ ### Whole-pack install
111
86
 
112
- Inspect and diagnose the resolved policy with:
87
+ Use this when you want the complete `.claude` skill pack:
113
88
 
114
89
  ```bash
115
- npx cc-devflow config resolve --cwd /path/to/your/project --format policy
116
- npx cc-devflow config get output.document_language --cwd /path/to/your/project
117
- npx cc-devflow config doctor --cwd /path/to/your/project
90
+ npx cc-devflow@latest init --dir /path/to/your/project
91
+ npx cc-devflow@latest init --dir /path/to/your/project --force
118
92
  ```
119
93
 
120
- See `config/user-config.template.yml` for the full sample.
94
+ `--force` upgrades only cc-devflow-managed distributed skills and preserves unrelated project files under `.claude`.
121
95
 
122
- ## 🧩 skills.sh Distribution
96
+ ### Source checkout
123
97
 
124
- [skills.sh](https://skills.sh/) is supported only as a distribution channel for the new `.claude` skills.
98
+ When developing this repository locally:
125
99
 
126
- Because skills.sh installs skills one by one, use it to pull the specific skills you want:
100
+ ```bash
101
+ node bin/cc-devflow-cli.js --help
102
+ node bin/cc-devflow-cli.js init --dir /tmp/example-project
103
+ node bin/cc-devflow-cli.js adapt --cwd /tmp/example-project --platform codex
104
+ ```
105
+
106
+ ### Single-skill install with skills.sh
107
+
108
+ [skills.sh](https://skills.sh/) is supported as a single-skill distribution channel:
127
109
 
128
110
  ```bash
129
111
  npx skills add https://github.com/Dimon94/cc-devflow --skill cc-roadmap
@@ -132,50 +114,64 @@ npx skills add https://github.com/Dimon94/cc-devflow --skill cc-investigate
132
114
  npx skills add https://github.com/Dimon94/cc-devflow --skill cc-do
133
115
  npx skills add https://github.com/Dimon94/cc-devflow --skill cc-check
134
116
  npx skills add https://github.com/Dimon94/cc-devflow --skill cc-act
135
- npx skills add https://github.com/Dimon94/cc-devflow --skill cc-spec-init
136
- npx skills add https://github.com/Dimon94/cc-devflow --skill cc-simplify
137
117
  ```
138
118
 
139
- Use `cc-devflow init` when you want the whole `.claude` pack.
119
+ Use `cc-devflow init` for the full pack, `cc-devflow adapt` for generated platform outputs, and `skills add` only when you want one skill at a time.
140
120
 
141
- Use `cc-devflow adapt` when you want generated multi-platform outputs.
121
+ ## Configuration
142
122
 
143
- Use skills.sh when you want to install or refresh a single skill.
123
+ CC-DevFlow reads layered YAML config before durable workflow documents are written:
144
124
 
145
- ## 🔁 Upgrade
125
+ ```text
126
+ ~/.cc-devflow/config.yml
127
+ <repo>/.cc-devflow/config.yml
128
+ <repo>/.cc-devflow/config.local.yml
129
+ ```
146
130
 
147
- Refresh the packaged `.claude` bundle with the latest CLI:
131
+ Precedence is deterministic: defaults < user < project < local < environment < CLI. `output.document_language` is machine-enforced and currently supports `en` and `zh-CN`. Non-standard preferences belong under `agent_preferences`; they guide style but do not override workflow contracts.
148
132
 
149
- ```bash
150
- npx cc-devflow@latest init --dir /path/to/your/project
151
- npx cc-devflow@latest adapt --cwd /path/to/your/project --all
133
+ ```yaml
134
+ version: 1
135
+ output:
136
+ document_language: en
137
+ agent_preferences:
138
+ general:
139
+ - Start with the conclusion.
140
+ documentation:
141
+ - Keep headings short and avoid marketing language.
152
142
  ```
153
143
 
154
- Upgrade installed skills with the skills CLI lifecycle commands:
144
+ Useful commands:
155
145
 
156
146
  ```bash
157
- npx skills check
158
- npx skills update
147
+ npx cc-devflow config init --cwd /path/to/your/project --project
148
+ npx cc-devflow config set output.document_language zh-CN --cwd /path/to/your/project --project
149
+ npx cc-devflow config resolve --cwd /path/to/your/project --format policy
150
+ npx cc-devflow config doctor --cwd /path/to/your/project
159
151
  ```
160
152
 
161
- If you only want to refresh one skill immediately, re-run its `npx skills add ... --skill ...` command.
153
+ See [`config/user-config.template.yml`](./config/user-config.template.yml) for the full sample.
162
154
 
163
- ## 🧱 Repository Format
155
+ ## Repository Format
164
156
 
165
- CC-DevFlow keeps the `.claude` skill folders compatible with skills.sh single-skill distribution:
157
+ Distributed skills live in `.claude/skills/`:
166
158
 
167
- - one skill per folder
168
- - one `SKILL.md` per distributed skill
169
- - YAML frontmatter at the top of each `SKILL.md`
170
- - public skills declare structured runtime contract fields in frontmatter: `triggers`, `reads`, structured `writes`, `effects`, `entry_gate`, `exit_criteria`, `reroutes`, `recovery_modes`, `tool_budget`
171
- - bundled local resources beside the skill, such as `PLAYBOOK.md`, `assets/`, `scripts/`, and `references/`
159
+ ```text
160
+ .claude/skills/<skill>/
161
+ ├── SKILL.md
162
+ ├── PLAYBOOK.md
163
+ ├── assets/
164
+ ├── references/
165
+ └── scripts/
166
+ ```
172
167
 
173
- Public skills also carry two explicit text contracts:
168
+ Each shipped skill keeps its runtime contract local:
174
169
 
175
- - `SKILL.md` includes a `Harness Contract` section
176
- - `PLAYBOOK.md` includes a `Visible State Machine` section
170
+ - `SKILL.md` has YAML frontmatter plus the `Harness Contract`
171
+ - `PLAYBOOK.md` has the `Visible State Machine`
172
+ - local resources stay beside the skill that owns them
177
173
 
178
- In this repository, the distributed skill folders are:
174
+ The currently distributed skill folders are:
179
175
 
180
176
  - `.claude/skills/cc-roadmap/`
181
177
  - `.claude/skills/cc-plan/`
@@ -186,58 +182,53 @@ In this repository, the distributed skill folders are:
186
182
  - `.claude/skills/cc-spec-init/`
187
183
  - `.claude/skills/cc-simplify/`
188
184
 
189
- ## 🛠️ Use
190
-
191
- The skill sequence remains:
185
+ ## Durable vs Ephemeral
192
186
 
193
- ```text
194
- 1. cc-roadmap
195
- 2. choose cc-plan or cc-investigate
196
- 3. cc-do
197
- 4. cc-check
198
- 5. cc-act
199
- 6. repeat
200
- ```
187
+ - `devflow/specs/` stores durable capability truth: `INDEX.md` plus `capabilities/*.md`.
188
+ - New change directories use `REQ-<number>-<description>` for requirements or `FIX-<number>-<description>` for bug fixes.
189
+ - `devflow/changes/<change>/` stores durable change truth: `change-state.json`, `change-meta.json`, planning docs, `task-manifest.json`, `team-state.json`, task `checkpoint.json`, `report-card.json`, and one final handoff file.
190
+ - `devflow/workspaces/<change>/` stores ephemeral runtime scratch such as worker assignment, journals, prompts, and session logs.
191
+ - Regenerable files should not be persisted under `devflow/changes/`.
201
192
 
202
- You do not need to remember command names.
193
+ For complete artifact examples, start with [`docs/examples/START-HERE.md`](./docs/examples/START-HERE.md). Example version bindings live in [`docs/examples/example-bindings.json`](./docs/examples/example-bindings.json).
203
194
 
204
- The `cc-devflow` CLI remains the whole-pack installation and adaptation path.
195
+ ## Development
205
196
 
206
- skills.sh remains the single-skill distribution path for distributed `.claude/skills/*`.
197
+ ```bash
198
+ git clone https://github.com/Dimon94/cc-devflow.git
199
+ cd cc-devflow
200
+ npm install
201
+ npm test
202
+ npm run verify
203
+ ```
207
204
 
208
- ## 📦 Outputs
205
+ Publish validation:
209
206
 
210
- - `cc-roadmap` writes `devflow/ROADMAP.md` and `devflow/BACKLOG.md`; helper sync can also maintain `devflow/roadmap-tracking.json` as the shared roadmap/backlog truth source
211
- - `cc-spec-init` writes `devflow/specs/INDEX.md`, capability specs, and `change-meta.json`
212
- - `cc-plan` writes `planning/design.md`, `planning/tasks.md`, `task-manifest.json`, and `change-meta.json`
213
- - `cc-investigate` writes `planning/analysis.md`, `planning/tasks.md`, `task-manifest.json`, and `change-meta.json`
214
- - `cc-do` writes code, tests, task `checkpoint.json`, and workspace scratch runtime
215
- - `cc-check` writes `report-card.json`
216
- - `cc-act` writes exactly one final handoff file: `handoff/pr-brief.md`, `handoff/resume-index.md`, or `handoff/release-note.md`
207
+ ```bash
208
+ npm run verify:publish
209
+ ```
217
210
 
218
- ## Durable vs Ephemeral
211
+ The main contributor guide is [`CONTRIBUTING.md`](./CONTRIBUTING.md). It explains the public surface rules, local CLI smoke tests, documentation rules, and PR expectations.
219
212
 
220
- - `devflow/specs/` stores durable capability truth: `INDEX.md` plus `capabilities/*.md`.
221
- - New change directories must be named `REQ-<number>-<description>` for requirements or `FIX-<number>-<description>` for bug fixes; old lowercase directories are compatibility reads only.
222
- - `devflow/changes/<change>/` stores durable change truth only: `change-state.json`, `change-meta.json`, planning docs, `task-manifest.json`, `team-state.json`, task `checkpoint.json`, `report-card.json`, and one final handoff file.
223
- - `devflow/workspaces/<change>/` stores ephemeral runtime scratch such as worker assignment, journals, prompts, and session logs.
224
- - If a file can be regenerated from durable truth, it should not be persisted under `devflow/changes/`.
213
+ ## Community
225
214
 
226
- See [docs/examples/START-HERE.md](./docs/examples/START-HERE.md) for the single entry page to the example set. Example version bindings live in [docs/examples/example-bindings.json](./docs/examples/example-bindings.json).
215
+ - Star the project if the workflow is useful: [GitHub stars](https://github.com/Dimon94/cc-devflow/stargazers)
216
+ - Open issues for reproducible bugs, stale docs, or missing platform adapters.
217
+ - Keep PRs focused: one skill, one CLI behavior, one compiler/adaptation fix, or one documentation cleanup.
218
+ - If a shipped skill changes, update its `version`, local `CHANGELOG.md`, examples, and affected public docs in the same PR.
219
+ - Read the [Code of Conduct](./CODE_OF_CONDUCT.md) before participating in project discussions.
220
+ - Report vulnerabilities through the [Security Policy](./SECURITY.md), not public issues.
227
221
 
228
- ## Principles
222
+ ## Star History
229
223
 
230
- - Roadmap before execution
231
- - Plan before feature code
232
- - Investigate before bug repair
233
- - Root cause before fix
234
- - Evidence before done
235
- - Ship, then feed the result into the next plan
224
+ <a href="https://www.star-history.com/#Dimon94/cc-devflow&Date">
225
+ <picture>
226
+ <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Dimon94/cc-devflow&type=Date&theme=dark" />
227
+ <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Dimon94/cc-devflow&type=Date" />
228
+ <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Dimon94/cc-devflow&type=Date" />
229
+ </picture>
230
+ </a>
236
231
 
237
- ## Verification
232
+ ## License
238
233
 
239
- ```bash
240
- find .claude/skills -mindepth 2 -maxdepth 2 -name SKILL.md | sort
241
- find .claude/skills -mindepth 2 -maxdepth 3 -type f | sort
242
- npm run verify
243
- ```
234
+ [MIT](./LICENSE)