ace-handbook 0.19.0 → 0.20.0

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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +87 -2
  3. data/README.md +1 -1
  4. data/handbook/guides/cli-dry-cli.g.md +4 -0
  5. data/handbook/guides/cli-support-cli.g.md +4 -0
  6. data/handbook/guides/coding-standards/ruby.md +1 -1
  7. data/handbook/guides/coding-standards.g.md +27 -0
  8. data/handbook/guides/debug-troubleshooting.g.md +11 -1
  9. data/handbook/guides/error-handling.g.md +6 -0
  10. data/handbook/guides/meta/agents-definition.g.md +94 -2
  11. data/handbook/guides/meta/guides-definition.g.md +31 -9
  12. data/handbook/guides/meta/markdown-definition.g.md +31 -1
  13. data/handbook/guides/meta/tools-definition.g.md +5 -0
  14. data/handbook/guides/meta/workflow-instructions-definition.g.md +37 -0
  15. data/handbook/guides/mono-repo-patterns.g.md +1 -0
  16. data/handbook/guides/multi-agent-research.g.md +5 -1
  17. data/handbook/guides/performance.g.md +7 -0
  18. data/handbook/guides/strategic-planning.g.md +2 -2
  19. data/handbook/guides/troubleshooting/ruby.md +14 -10
  20. data/handbook/guides/troubleshooting/rust.md +11 -9
  21. data/handbook/guides/troubleshooting/typescript.md +11 -9
  22. data/handbook/guides/workflow-context-embedding.g.md +16 -0
  23. data/handbook/skills/as-release-rubygems-publish/SKILL.md +1 -0
  24. data/handbook/templates/completed-work-documentation.md +5 -1
  25. data/handbook/templates/cookbooks/cookbook.template.md +21 -1
  26. data/handbook/templates/research-comparison.template.md +7 -6
  27. data/handbook/workflow-instructions/handbook/init-project.wf.md +78 -1
  28. data/handbook/workflow-instructions/handbook/manage-agents.wf.md +40 -0
  29. data/handbook/workflow-instructions/handbook/manage-guides.wf.md +30 -30
  30. data/handbook/workflow-instructions/handbook/manage-workflows.wf.md +36 -30
  31. data/handbook/workflow-instructions/handbook/parallel-research.wf.md +15 -0
  32. data/handbook/workflow-instructions/handbook/perform-delivery.wf.md +6 -1
  33. data/handbook/workflow-instructions/handbook/research.wf.md +5 -0
  34. data/handbook/workflow-instructions/handbook/review-guides.wf.md +45 -45
  35. data/handbook/workflow-instructions/handbook/review-workflows.wf.md +30 -30
  36. data/handbook/workflow-instructions/handbook/synthesize-research.wf.md +15 -0
  37. data/handbook/workflow-instructions/handbook/update-docs.wf.md +29 -21
  38. data/lib/ace/handbook/version.rb +1 -1
  39. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b0d7a79a21b2d55e4fd1a583f2825f10eff4e163629b49520c7aa50096e6472c
4
- data.tar.gz: 38696630f7cad28c282e6904195c397d808d667f6fe5c9543b31aaba3bf0d97c
3
+ metadata.gz: 34e4176eea98052a12774fd7d3a783ad1652d8ce0353af35a66263ef8ee77657
4
+ data.tar.gz: f7da1f201a22962d9f379043bba68d734f382e57abeeb6dc9cb4db61d18d774d
5
5
  SHA512:
6
- metadata.gz: a6f780c0d782d95b6d9799e12b5d9f5787328b953d02dcd77720961a428bded1004793cf91928d321494feb1eb6c1582d48ede4667514b5a456ad3e91a2e9cc6
7
- data.tar.gz: 2137a2d0924441c6f462f5bfa682b809f429d93ad1585a71ebdd82a09b2e8df8c217508a08c81b9a65b226ce788f1d1c83819cf5e7e2b0ad330e00db1e6a8f9b
6
+ metadata.gz: 44c23f6ca95440a2ad10ff93a3d8cdf110d6a5e52f244546bfbc22300673fc694f81aa24c6f5305f310dd640f2758a954673ebd3e5181002ffe578e35733ebe5
7
+ data.tar.gz: 67bca77bf1d7bcd5f73c219413686c5cff1c8f4ad76e785ae6a3f86291055f312d6230f07b089269e316751321d8da5323de9a26ad53d7bf949bc1372104e670
data/CHANGELOG.md CHANGED
@@ -1,4 +1,5 @@
1
1
  # Changelog
2
+
2
3
  All notable changes to this project will be documented in this file.
3
4
 
4
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,18 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6
7
 
7
8
  ## [Unreleased]
8
9
 
10
+ ## [0.20.0] - 2026-03-28
11
+
12
+ ### Added
13
+
14
+ - Added `bin/ace-rubygems-needs-release` to derive pending ACE RubyGems releases from a single remote snapshot instead of querying each gem individually.
15
+
16
+ ### Changed
17
+
18
+ - Updated the RubyGems publish workflow to prefer the helper script when available and corrected the fallback `gem search --exact` guidance.
19
+ - Updated `as-release-rubygems-publish` skill instructions to prefer the helper script for pending-release discovery.
20
+
9
21
  ## [0.19.0] - 2026-03-23
10
22
 
11
23
  ### Added
24
+
12
25
  - New use case in README documenting `ace-handbook sync` and `ace-handbook status` CLI commands.
13
26
  - Added `as-release`, `as-release-bump-version`, `as-release-rubygems-publish`, and `as-release-update-changelog` to the handbook skills reference table.
14
27
  - Re-recorded getting-started demo GIF showcasing provider status and sync workflows.
15
28
 
16
29
  ### Fixed
17
- - Fixed broken `[ace-nav](../ace-nav)` cross-link in README — corrected to `[ace-nav](../ace-support-nav)`.
18
- - Fixed incorrect `ace-integration-*` package reference in README corrected to `ace-handbook-integration-*`.
30
+
31
+ - Fixed broken `[ace-nav](../ace-nav)` cross-link in README -- corrected to `[ace-nav](../ace-support-nav)`.
32
+ - Fixed incorrect `ace-integration-*` package reference in README -- corrected to `ace-handbook-integration-*`.
19
33
 
20
34
  ### Changed
35
+
21
36
  - Aligned gemspec description wording with summary for consistency.
22
37
  - Removed stale `mise` prerequisite from `docs/getting-started.md`.
23
38
  - Rewrote demo tape to focus on `ace-handbook status` and `ace-handbook sync --provider pi`.
@@ -25,23 +40,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
25
40
  ## [0.18.3] - 2026-03-23
26
41
 
27
42
  ### Changed
43
+
28
44
  - Refreshed `README.md` to the current package layout pattern with quick-link navigation, use-case framing, and normalized section order.
29
45
 
30
46
  ## [0.18.2] - 2026-03-22
31
47
 
32
48
  ### Changed
49
+
33
50
  - Updated `docs/getting-started.md` to remove contradictory `mise exec --` prose and align onboarding guidance with direct `ace-*` command usage.
34
51
  - Documented intentional retirement of projected provider `as-idea-capture` and `as-idea-capture-features` skill files after canonical source removal.
35
52
 
36
53
  ## [0.18.1] - 2026-03-22
37
54
 
38
55
  ### Changed
56
+
39
57
  - Remove `mise exec --` wrapper from test fixture strings and canonical skill docs.
40
58
  - Document intentional retirement of projected provider `as-idea-capture` and `as-idea-capture-features` skill files after canonical source removal.
41
59
 
42
60
  ## [0.18.0] - 2026-03-22
43
61
 
44
62
  ### Changed
63
+
45
64
  - Reworked `ace-handbook` documentation into a landing-page README with package-focused messaging and links to dedicated docs.
46
65
  - Added `docs/getting-started.md`, `docs/usage.md`, and `docs/handbook.md` with tutorial and workflow/skill reference coverage.
47
66
  - Added demo assets under `docs/demo/` and aligned examples to the current `ace-nav resolve/list` command pattern.
@@ -50,181 +69,219 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
50
69
  ## [0.17.1] - 2026-03-21
51
70
 
52
71
  ### Added
72
+
53
73
  - Add RubyGems publish workflow (`wfi://release/rubygems-publish`) for publishing ACE gems in dependency order with credential verification, conflict detection, and dry-run support.
54
74
  - Add `as-release-rubygems-publish` skill for invoking the RubyGems publish workflow.
55
75
 
56
76
  ## [0.17.0] - 2026-03-21
57
77
 
58
78
  ### Changed
79
+
59
80
  - Added initial `TS-HANDBOOK-001` value-gated smoke E2E coverage for `ace-handbook` CLI help and status command contracts.
60
81
 
61
82
  ## [0.16.1] - 2026-03-18
62
83
 
63
84
  ### Changed
85
+
64
86
  - Migrated CLI namespace from `Ace::Core::CLI::*` to `Ace::Support::Cli::*` (ace-support-cli is now the canonical home for CLI infrastructure).
65
87
 
66
88
 
67
89
  ## [0.16.0] - 2026-03-18
68
90
 
69
91
  ### Changed
92
+
70
93
  - Removed legacy backward-compatibility behavior as part of the 0.10 cleanup release.
71
94
 
72
95
 
73
96
  ## [0.15.9] - 2026-03-18
74
97
 
75
98
  ### Fixed
99
+
76
100
  - Updated `cli-support-cli.g.md` guide to remove stale `DryCli::` namespace prefix from `VersionCommand` and `HelpCommand` class references.
77
101
 
78
102
  ## [0.15.8] - 2026-03-17
79
103
 
80
104
  ### Changed
105
+
81
106
  - Updated `cli-support-cli.g.md` examples to the current `ace-support-cli` API (`RegistryDsl`, `Runner`, and `coerce_types`).
82
107
  - Updated review workflow docs to reflect 15-minute timeout guidance for long PR review runs.
83
108
 
84
109
  ## [0.15.7] - 2026-03-15
85
110
 
86
111
  ### Changed
112
+
87
113
  - Migrated CLI framework from dry-cli to ace-support-cli
88
114
 
89
115
  ## [0.15.6] - 2026-03-13
90
116
 
91
117
  ### Changed
118
+
92
119
  - Updated handbook-owned canonical skills to explicitly run bundled workflows in the current project and execute them end-to-end.
93
120
 
94
121
  ### Technical
122
+
95
123
  - Refreshed provider sync and status collector regression coverage for the new compact canonical skill execution template.
96
124
 
97
125
  ## [0.15.5] - 2026-03-13
98
126
 
99
127
  ### Changed
128
+
100
129
  - Removed provider-specific skill body rendering so projected provider skills once again apply frontmatter overrides while preserving the canonical skill body unchanged.
101
130
  - Updated the canonical `as-release` skill to use the unified arguments / variables / execution structure with explicit workflow-execution guidance.
102
131
  - Limited provider-specific forking for `as-release` to Claude frontmatter only.
103
132
 
104
133
  ### Technical
134
+
105
135
  - Simplified handbook projection coverage to validate frontmatter override projection and canonical body preservation instead of provider-specific body rendering.
106
136
 
107
137
  ## [0.15.4] - 2026-03-13
108
138
 
109
139
  ### Changed
140
+
110
141
  - Strengthened projected workflow skill instructions for Codex delegated execution and forked provider contexts so generated provider skills explicitly load and execute workflows in the current project instead of only reading or summarizing them.
111
142
 
112
143
  ### Technical
144
+
113
145
  - Added projection regression coverage for strong workflow-execution rendering in both Codex `context: ace-llm` mode and provider `context: fork` mode.
114
146
 
115
147
  ## [0.15.3] - 2026-03-13
116
148
 
117
149
  ### Changed
150
+
118
151
  - Render Codex `ace-llm` skills from canonical frontmatter by deriving uppercase variables from `argument-hint` and generating `## Variables` / `## Instructions` sections for projected Codex skills.
119
152
 
120
153
  ### Technical
154
+
121
155
  - Added projection regression coverage for `context: ace-llm` rendering and argument-hint-derived Codex variable generation.
122
156
 
123
157
  ## [0.15.2] - 2026-03-12
124
158
 
125
159
  ### Fixed
160
+
126
161
  - Preserved conditional `--sandbox` workflow routing in provider-synced skill projections so generated Claude and Codex skills keep the canonical E2E execute path.
127
162
 
128
163
  ### Technical
164
+
129
165
  - Added provider-sync regression coverage for conditional workflow bodies in projected skills.
130
166
 
131
167
  ## [0.15.1] - 2026-03-12
132
168
 
133
169
  ### Changed
170
+
134
171
  - Updated handbook README, workflow docs, and guidance to document bundle-first workflow usage and the current handbook structure.
135
172
 
136
173
  ## [0.15.0] - 2026-03-12
137
174
 
138
175
  ### Added
176
+
139
177
  - Added Codex-specific delegated execution metadata to the canonical `as-release-bump-version` and `as-release-update-changelog` skills so the generated Codex skills run in fork context on `gpt-5.3-codex-spark`.
140
178
 
141
179
  ## [0.14.1] - 2026-03-12
142
180
 
143
181
  ### Technical
182
+
144
183
  - Updated provider sync regression coverage to verify provider-specific `context` and `model` overrides on projected git-commit skills and to keep generated provider output free of canonical `integration` metadata.
145
184
 
146
185
  ## [0.14.0] - 2026-03-12
147
186
 
148
187
  ### Changed
188
+
149
189
  - Changed canonical handbook skill inventory to load from registered `skill://` sources via `ace-support-nav` instead of scanning monorepo package directories directly.
150
190
 
151
191
  ### Technical
192
+
152
193
  - Added nav-backed inventory regression coverage and explicit skill-source registration fixtures for handbook sync/status tests.
153
194
 
154
195
  ## [0.13.1] - 2026-03-12
155
196
 
156
197
  ### Technical
198
+
157
199
  - Added regression coverage for the `.agent/skills` retirement so handbook sync/status changes are exercised against provider-native skill trees only.
158
200
 
159
201
  ## [0.13.0] - 2026-03-12
160
202
 
161
203
  ### Added
204
+
162
205
  - Added canonical skill inventory counts by `source` to `ace-handbook status` output and JSON responses.
163
206
 
164
207
  ### Changed
208
+
165
209
  - Expanded provider status reporting to show expected, installed, in-sync, outdated, missing, and extra skill counts, including comparisons through symlinked provider directories.
166
210
 
167
211
  ## [0.12.0] - 2026-03-10
168
212
 
169
213
  ### Added
214
+
170
215
  - Added a public `ace-handbook` CLI with `sync` and `status` commands for projecting canonical package skills into provider-native folders.
171
216
  - Added provider manifest discovery and sync/status coverage for handbook integrations, including replacement of legacy provider skill symlinks with real provider directories.
172
217
 
173
218
  ### Changed
219
+
174
220
  - Moved handbook integration execution to `ace-handbook` while provider packages now supply thin provider manifests for projection targets.
175
221
 
176
222
  ## [0.11.0] - 2026-03-10
177
223
 
178
224
  ### Added
225
+
179
226
  - Added canonical handbook-owned skills for handbook management, release workflows, and research/delivery orchestration.
180
227
 
181
228
 
182
229
  ## [0.10.0] - 2026-03-08
183
230
 
184
231
  ### Added
232
+
185
233
  - New `release/publish` workflow for coordinated multi-package releases that auto-detect modified packages, update package and root changelogs, and finish with one release commit.
186
234
 
187
235
  ### Changed
236
+
188
237
  - `/as-release` now loads `wfi://release/publish`, and release documentation now points to the canonical workflow path.
189
238
 
190
239
  ## [0.9.9] - 2026-03-04
191
240
 
192
241
  ### Changed
242
+
193
243
  - Update `perform-delivery` workflow PR skill references from `/ace-git-create-pr` to `/ace-github-pr-create`
194
244
 
195
245
  ## [0.9.8] - 2026-02-25
196
246
 
197
247
  ### Changed
248
+
198
249
  - Update `perform-delivery` workflow task lookup guidance to use `ace-task show <ref>` for explicit task selection.
199
250
 
200
251
  ## [0.9.7] - 2026-02-22
201
252
 
202
253
  ### Technical
254
+
203
255
  - Update `ace-bundle project` → `ace-bundle load project` in update-docs workflow
204
256
 
205
257
  ## [0.9.6] - 2026-02-22
206
258
 
207
259
  ### Changed
260
+
208
261
  - Migrate skill naming and invocation references to hyphenated `ace-*` format (no underscores).
209
262
 
210
263
  ## [0.9.5] - 2026-02-21
211
264
 
212
265
  ### Added
266
+
213
267
  - "Redundant computation" root cause category in selfimprove workflow with fix template showing compute-once-pass-explicitly pattern
214
268
 
215
269
  ## [0.9.4] - 2026-02-20
216
270
 
217
271
  ### Technical
272
+
218
273
  - Update /ace:create-pr to /ace:git-create-pr in perform-delivery workflow
219
274
 
220
275
  ## [0.9.3] - 2026-02-20
221
276
 
222
277
  ### Technical
278
+
223
279
  - Update stale wfi:// references in workflow definition guide
224
280
 
225
281
  ## [0.9.2] - 2026-02-19
226
282
 
227
283
  ### Technical
284
+
228
285
  - Namespace workflow instructions into handbook/ subdirectory with updated wfi:// URIs
229
286
  - Update skill name references to use namespaced ace:handbook-action format
230
287
 
@@ -237,77 +294,97 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
237
294
  ## [0.9.0] - 2026-02-03
238
295
 
239
296
  ### Added
297
+
240
298
  - Self-improve workflow (`selfimprove.wf.md`) for transforming agent mistakes into system improvements
241
299
 
242
300
  ## [0.8.0] - 2026-01-31
243
301
 
244
302
  ### Added
303
+
245
304
  - Multi-agent research synthesis capabilities (Task 254):
305
+
246
306
  - `multi-agent-research.g.md` guide explaining when/how to use parallel agents
247
307
  - `research-comparison.template.md` for structured synthesis comparison
248
308
  - `parallel-research.wf.md` workflow for setting up parallel agent research
249
309
  - `synthesize-research.wf.md` workflow for combining agent outputs
250
310
  - `research.wf.md` with single/multi-agent decision criteria
311
+
251
312
  - Template protocol source configuration for ace-handbook templates
252
313
 
253
314
  ## [0.7.1] - 2026-01-29
254
315
 
255
316
  ### Fixed
317
+
256
318
  - Refine exit code handling documentation for dry-cli framework with exception-based pattern
257
319
 
258
320
  ## [0.7.0] - 2026-01-22
259
321
 
260
322
  ### Added
323
+
261
324
  - New guides extracted from ace-gems.g.md for better discoverability:
325
+
262
326
  - `prompt-caching.g.md` - PromptCacheManager patterns for LLM prompt generation
263
327
  - `cli-dry-cli.g.md` - Complete dry-cli framework reference
264
328
  - `mono-repo-patterns.g.md` - Mono-repo development patterns and binstubs
329
+
265
330
  - Document IO isolation and testing pyramid patterns
266
331
 
267
332
  ### Technical
333
+
268
334
  - Lower Ruby version requirement to >= 3.2.0
269
335
 
270
336
  ## [0.6.0] - 2026-01-18
271
337
 
272
338
  ### Added
339
+
273
340
  - Add perform-delivery workflow for multi-step delivery tracking with automatic TodoWrite externalization
274
341
 
275
342
  ### Technical
343
+
276
344
  - Update guides for bundle terminology
277
345
 
278
346
  ## [0.5.2] - 2026-01-16
279
347
 
280
348
  ### Changed
349
+
281
350
  - Rename context: to bundle: keys in configuration files
282
351
 
283
352
  ## [0.5.1] - 2026-01-08
284
353
 
285
354
  ### Fixed
355
+
286
356
  - Fixed `guide://` protocol links in ace-test-runner guides (added `.g` suffix for `.g.md` files)
287
357
  - Cross-gem guide:// links now properly resolve to resources with `.g` extension
288
358
 
289
359
  ## [0.5.0] - 2026-01-08
290
360
 
291
361
  ### Added
362
+
292
363
  - Migrated 10 generic guides from dev-handbook to handbook/guides/
364
+
293
365
  - ai-agent-integration.g.md, atom-pattern.g.md, changelog.g.md
294
366
  - coding-standards.g.md, debug-troubleshooting.g.md, error-handling.g.md
295
367
  - performance.g.md, quality-assurance.g.md, strategic-planning.g.md
368
+
296
369
  - Migrated 5 meta-guides to handbook/guides/meta/
370
+
297
371
  - agents-definition.g.md, guides-definition.g.md, markdown-definition.g.md
298
372
  - tools-definition.g.md, workflow-instructions-definition.g.md
373
+
299
374
  - Guide subdirectories with language-specific content (ruby, rust, typescript)
300
375
  - initialize-project-structure.wf.md workflow for project setup
301
376
  - Templates: cookbooks/cookbook.template.md, completed-work-documentation.md
302
377
  - Template discovery protocol (.ace-defaults/nav/protocols/tmpl-sources/)
303
378
 
304
379
  ### Changed
380
+
305
381
  - Consolidates dev-handbook content into ace-handbook gem
306
382
  - All development guides now distributed with gem installation
307
383
 
308
384
  ## [0.4.0] - 2026-01-03
309
385
 
310
386
  ### Added
387
+
311
388
  - Guides support with handbook/guides/ directory
312
389
  - workflow-context-embedding.g.md guide for embed_document_source pattern
313
390
  - Guide discovery protocol (.ace-defaults/nav/protocols/guide-sources/ace-handbook.yml)
@@ -315,6 +392,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
315
392
  ## [0.3.0] - 2026-01-03
316
393
 
317
394
  ### Changed
395
+
318
396
  - **BREAKING**: Minimum Ruby version raised to 3.3.0 (was 3.1.0)
319
397
  - Standardized gemspec file patterns with deterministic Dir.glob
320
398
  - Added MIT LICENSE file
@@ -328,33 +406,40 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
328
406
  ## [0.1.0] - 2025-11-05
329
407
 
330
408
  ### Added
409
+
331
410
  - Initial release of ace-handbook gem as pure workflow package
332
411
  - 6 handbook management workflows accessible via wfi:// protocol:
412
+
333
413
  - `wfi://manage-guides` - Create and update development guides
334
414
  - `wfi://review-guides` - Review guides for quality and consistency
335
415
  - `wfi://manage-workflow-instructions` - Create and validate workflow files
336
416
  - `wfi://review-workflows` - Review workflow instructions
337
417
  - `wfi://manage-agents` - Create and update agent definitions
338
418
  - `wfi://update-handbook-docs` - Update handbook README and structure
419
+
339
420
  - Path references updated for project-relative usage
340
421
  - Complete gem structure following ACE patterns
341
422
  - Comprehensive documentation and usage examples
342
423
  - Auto-discovery support through ace-nav gem
343
424
 
344
425
  ### Changed
426
+
345
427
  - Migrated workflows from dev-handbook/.meta/wfi/ to installable gem
346
428
  - Updated path references to be project-root relative
347
429
  - Removed dev-handbook specific dependencies
348
430
 
349
431
  ### Removed
432
+
350
433
  - Moved `update-tools-docs.wf.md` to ace-docs package (tools documentation management)
351
434
  - Moved `update-integration-claude.wf.md` to ace-integration-claude package (Claude Code integration)
352
435
 
353
436
  ### Fixed
437
+
354
438
  - Added ace-nav protocol registration (.ace.example/nav/protocols/wfi-sources/ace-handbook.yml)
355
439
  - Updated gemspec to include protocol registration files for proper discovery
356
440
 
357
441
  ### Technical Details
442
+
358
443
  - Pure workflow package with no Ruby runtime dependencies
359
444
  - Auto-discovery via ace-nav through handbook/workflow-instructions/ directory
360
445
  - Protocol registration enables ace-nav to discover workflows from installed gem
data/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  Standardized workflows for creating and managing guides, workflow instructions, and agent definitions.
5
5
 
6
- <img src="https://raw.githubusercontent.com/cs3b/ace/main/docs/brand/AgenticCodingEnvironment.Logo.XS.jpg" alt="ACE Logo" width="480">
6
+ <img src="../docs/brand/AgenticCodingEnvironment.Logo.XS.jpg" alt="ACE Logo" width="480">
7
7
  <br><br>
8
8
 
9
9
  <a href="https://rubygems.org/gems/ace-handbook"><img alt="Gem Version" src="https://img.shields.io/gem/v/ace-handbook.svg" /></a>
@@ -16,6 +16,7 @@ Complete reference for implementing CLI interfaces in ace-* gems using dry-cli.
16
16
  All ACE CLI gems use dry-cli. See [ADR-023](../../../docs/decisions/ADR-023-dry-cli-framework.md) for decision rationale.
17
17
 
18
18
  **Two patterns:**
19
+
19
20
  - **Multi-command**: Subcommand tools (ace-bundle, ace-taskflow)
20
21
  - **Single-command**: One-action tools (ace-git-commit, ace-search)
21
22
 
@@ -73,6 +74,7 @@ end
73
74
  ```
74
75
 
75
76
  **Exe wrapper:**
77
+
76
78
  ```ruby
77
79
  #!/usr/bin/env ruby
78
80
  require "ace/gem"
@@ -113,6 +115,7 @@ end
113
115
  ```
114
116
 
115
117
  **Exe wrapper:**
118
+
116
119
  ```ruby
117
120
  #!/usr/bin/env ruby
118
121
  require "ace/gem"
@@ -232,6 +235,7 @@ end
232
235
  ```
233
236
 
234
237
  **Exe wrapper catches exceptions:**
238
+
235
239
  ```ruby
236
240
  #!/usr/bin/env ruby
237
241
  require "ace/gem"
@@ -16,6 +16,7 @@ Complete reference for implementing CLI interfaces in ace-* gems using ace-suppo
16
16
  All ACE CLI gems use ace-support-cli. See [ADR-023](../../../docs/decisions/ADR-023-ace-support-cli-framework.md) for decision rationale.
17
17
 
18
18
  **Two patterns:**
19
+
19
20
  - **Multi-command**: Subcommand tools (ace-bundle, ace-taskflow)
20
21
  - **Single-command**: One-action tools (ace-git-commit, ace-search)
21
22
 
@@ -73,6 +74,7 @@ end
73
74
  ```
74
75
 
75
76
  **Exe wrapper:**
77
+
76
78
  ```ruby
77
79
  #!/usr/bin/env ruby
78
80
  require "ace/gem"
@@ -113,6 +115,7 @@ end
113
115
  ```
114
116
 
115
117
  **Exe wrapper:**
118
+
116
119
  ```ruby
117
120
  #!/usr/bin/env ruby
118
121
  require "ace/gem"
@@ -232,6 +235,7 @@ end
232
235
  ```
233
236
 
234
237
  **Exe wrapper catches exceptions:**
238
+
235
239
  ```ruby
236
240
  #!/usr/bin/env ruby
237
241
  require "ace/gem"
@@ -33,7 +33,7 @@ addition to the generic standards in `../coding-standards.md`.
33
33
 
34
34
  ## Performance Tips
35
35
 
36
- - Prefer `each` over `map` when you dont need the new array.
36
+ - Prefer `each` over `map` when you don't need the new array.
37
37
  - Avoid creating unnecessary objects in hot code paths.
38
38
 
39
39
  ---
@@ -22,15 +22,23 @@ in the relevant `dev-taskflow/` directory or linked from the `docs/blueprint.md`
22
22
  ## General Principles
23
23
 
24
24
  - **Clarity & Readability:** Write code that is easy for others (and your future self) to understand. Use
25
+
25
26
  meaningful variable names, keep functions/methods short and focused, and add comments where logic is
26
27
  complex or non-obvious.
28
+
27
29
  - **Consistency:** Follow established patterns and conventions within the project. If using a style guide tool
30
+
28
31
  (like StandardRB, RuboCop), adhere to its rules.
32
+
29
33
  - **Simplicity (KISS):** Avoid unnecessary complexity. Prefer straightforward solutions unless a more complex
34
+
30
35
  approach offers significant, justifiable benefits (e.g., performance).
36
+
31
37
  - **Don\'t Repeat Yourself (DRY):** Abstract common logic into reusable functions, methods, or classes.
32
38
  - **Modularity:** Design components with clear responsibilities and well-defined interfaces. Aim for loose
39
+
33
40
  coupling and high cohesion.
41
+
34
42
  - **Testability:** Write code that is easy to test. Use dependency injection and avoid tight coupling to
35
43
 
36
44
  ## Language-Specific Coding Standards
@@ -45,9 +53,12 @@ Please refer to the relevant guide for your language:
45
53
 
46
54
  - **Indentation:** Use consistent indentation (e.g., 2 spaces for Ruby).
47
55
  - **Line Length:** Adhere to a reasonable line length limit (e.g., 100-120 characters) to improve
56
+
48
57
  readability.
58
+
49
59
  - **Whitespace:** Use whitespace effectively to separate logical blocks of code.
50
60
  - **Tooling:** Utilize automated formatters and linters (e.g., StandardRB, Prettier) to enforce
61
+
51
62
  consistency. Configure these tools via project configuration files (e.g., `.standard.yml`, `.prettierrc`).
52
63
 
53
64
  ## Error Handling
@@ -75,6 +86,7 @@ Please refer to the relevant guide for your language:
75
86
 
76
87
  - Follow a logical directory structure (e.g., separating library code, tests, configuration, documentation).
77
88
  - Use clear and consistent file naming conventions.
89
+
78
90
  Refer to the project's `docs/blueprint.md` for the specific structure.
79
91
 
80
92
  ## AI-Assisted Development Collaboration
@@ -83,26 +95,41 @@ When working with AI coding agents (like Cursor, Claude, etc.), treat them as co
83
95
  to a junior developer needing clear guidance.
84
96
 
85
97
  - **Plan Before Prompting:** Thoroughly plan the task, including outlining steps, defining requirements, and
98
+
86
99
  identifying relevant context *before* asking the AI to generate or modify code. This aligns with the
87
100
  "Slow Vibe Coding" principle mentioned in Project Management.
101
+
88
102
  - **Provide Context:** Give the AI sufficient context, including relevant code snippets, project structure
103
+
89
104
  (`docs/blueprint.md`), architecture (`docs/architecture.md`), existing patterns, and the
90
105
  specific task definition (`.md` file within `dev-taskflow`).
106
+
91
107
  - **Use Specific, Concise Instructions:** Avoid vague requests. Break down complex tasks into smaller,
108
+
92
109
  well-defined steps. Use clear action verbs and specify the desired outcome. Consider using "prompt hygiene"
93
110
  like "ONLY IMPLEMENT EXACTLY THIS STEP" for focused changes.
111
+
94
112
  - **Structured Prompts:** Structure prompts clearly, defining the AI\'s role, the objective, step-by-step instructions,
113
+
95
114
  and the desired output format (XML is often preferred by models like GPT-4.1). Include examples (few-shot learning)
96
115
  where appropriate.
116
+
97
117
  - **Review Rigorously:** Review AI-generated code with the same scrutiny as human-written code. Check for
118
+
98
119
  correctness, adherence to standards, edge cases, security, and performance implications. Do not blindly
99
120
  trust AI output.
121
+
100
122
  - **Iterate and Refine:** Expect to iterate. Provide constructive feedback on the AI\'s output to guide it
123
+
101
124
  towards the desired solution. Ask for explanations of its logic to learn and verify understanding.
125
+
102
126
  - **Leverage Strengths:** Use AI for tasks it excels at (e.g., boilerplate code, implementing well-defined
127
+
103
128
  algorithms, refactoring based on clear rules) but rely on human oversight for complex design decisions
104
129
  and architectural planning.
130
+
105
131
  - **Avoid "Hacky" Prompts:** Modern models respond better to clear instructions than tricks like excessive
132
+
106
133
  capitalization or emotional appeals.
107
134
 
108
135
  Refer to the [Project Management Guide](guide://project-management) for how AI collaboration fits
@@ -16,7 +16,7 @@ debugging to seeking help.
16
16
 
17
17
  | Step | What to do | Why |
18
18
  |------|------------|-----|
19
- | **1 Understand the system** | Skim docs/architecture first | You cant debug what you dont grasp. |
19
+ | **1 Understand the system** | Skim docs/architecture first | You can't debug what you don't grasp. |
20
20
  | **2 Make it fail on demand** | Reproduce the bug and minimise the input or scenario | Gives you a quick feedback loop & future test. |
21
21
  | **3 Collect evidence** | Read stack traces, logs, error codes | Surface clues without touching code. |
22
22
  | **4 Check recent changes/config** | Roll back toggles, feature flags, deployments | Regressions are usually fresh. |
@@ -30,13 +30,20 @@ debugging to seeking help.
30
30
  ## Elaborations on Key Steps
31
31
 
32
32
  * **Step 2: Make it fail on demand:** This is crucial for effective testing. Aim for the *simplest possible*
33
+
33
34
  reproducible case. This often forms the basis of a new regression test (see Step 8).
35
+
34
36
  * **Step 3 & 4: Collect evidence & Check recent changes:** Don't underestimate logs, configuration files, and
37
+
35
38
  recent commits (`git log`, `git blame`). Many issues are regressions introduced by recent changes.
39
+
36
40
  * **Step 8: Validate & Regress-Test:** After applying a fix, *always* run the minimal failing case you created in
41
+
37
42
  Step 2 to confirm the specific issue is resolved. Then, run the broader test suite (e.g., `bin/rspec`, `npm test`)
38
43
  to check for unintended side-effects. Refer to the [Testing Guidelines Guide](testing.g.md) for more details.
44
+
39
45
  * **Step 10: Escalate or Rubber Duck:** If you're stuck after diligently following the steps:
46
+
40
47
  * **Rubber Ducking:** Explain the problem out loud (to yourself, a pet, or an inanimate object). This often
41
48
  clarifies your thinking.
42
49
  * **AI Assistance:** Consult an AI agent. Use structured prompts, providing the context (code, error, steps taken).
@@ -48,8 +55,11 @@ debugging to seeking help.
48
55
  ## Utilizing Documentation and Research
49
56
 
50
57
  * **Internal Docs:** Before extensive debugging, always check project-specific documentation (`README.md`,
58
+
51
59
  architecture diagrams in project docs, specific guides via `guide://` protocol).
60
+
52
61
  * **External Research:** Use search engines effectively. Formulate precise queries including error messages,
62
+
53
63
  technology names, and library versions.
54
64
 
55
65
  ## Language-Specific Considerations