Skip to content

Commit 8ccc22d

Browse files
IronAdamantclaude
andcommitted
docs: add Design Notes section clarifying coupling behavior and coverage gap
- Explain co-change vs import-graph coupling (solo-agent vs multi-agent) - Document graduated coverage gap scoring (0.0/0.25/0.5/0.75/1.0) - Note that `analyze` does not accept --verbose flag Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent bed1d27 commit 8ccc22d

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,26 @@ chisel stats
144144

145145
Chisel works standalone or alongside [Stele](https://github.com/IronAdamant/Stele) for multi-agent code coordination. Chisel handles test intelligence; Stele handles document-level context and conflict prevention.
146146

147+
## Design Notes
148+
149+
### Coupling: co-change vs. import-graph
150+
151+
Chisel's `coupling` tool has two coupling sources:
152+
153+
1. **Co-change coupling** (`co_change_partners`) — files that frequently appear in the same git commits. This signal requires **multiple agents or multiple human collaborators** making separate commits. In solo-agent workflows, there is no co-change signal and this returns 0.0.
154+
155+
2. **Import-graph coupling** (`import_partners`) — static `import`/`require` edges between source files. This works in any project and provides structural coupling data even when co-change is absent.
156+
157+
When co-change is 0.0, import coupling still provides meaningful structural data. The `risk_map` tool uses the maximum of the two coupling sources.
158+
159+
### Coverage Gap: Graduated Scoring
160+
161+
Coverage gap is quantized to 4 steps (0.0, 0.25, 0.5, 0.75, 1.0) rather than binary. This graduated scoring provides finer granularity for risk assessment in `risk_map`.
162+
163+
### `--verbose` Flag
164+
165+
`chisel analyze` does not accept a `--verbose` flag. Using it causes the command to silently fail. For diagnostic output after analysis, use `chisel stats` to verify edge counts.
166+
147167
## License
148168

149169
MIT

0 commit comments

Comments
 (0)