eric/ConfigKit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Repair development guide formatting

Browse Source
This commit is contained in:
Eric Rakestraw
2026-09-12 17:26:12 +00:00
parent c98435ce8e
commit 88e86de03e
2 changed files with 20 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/development.md
View File

@@ -106,20 +106,7 @@ code changes. Use the component overview to find the corresponding implementatio
| Paths, metadata, provenance | [Paths](../internal/engine/path_test.go), [metadata](../internal/engine/metadata_test.go), [provenance](../internal/engine/provenance_test.go) | `go test ./internal/engine -run 'Path\|Metadata\|Provenance\|Queries'` |
| Secrets, bootstrap, redaction, explanation | [References](../internal/engine/secret_reference_test.go), [bootstrap](../internal/engine/secrets_test.go), [rendering](../internal/engine/render_test.go), [explanation](../internal/engine/explain_test.go) | `go test ./internal/engine -run 'Secret\|Bootstrap\|Effective\|Explain\|Explanation\|History\|Sensitivity'` |
| Consumer examples and migration fixtures | [Consumer tests](../examples/consumers/consumers_test.go), [API examples](../example_test.go) | `go test ./examples/consumers` and `go test . -run '^Example'` |
| Documentation links and dependency isolation | [Link checks](../documentation_test.go), [import boundary](../import_boundary_test.go) | `go test . -run 'TestLocalDocumentationLinks|TestDependencyImportBoundary|TestPublicFacadeBoundary'` |
| Check-command behavior | [Shell regression](../release_check_test.go) | `go test . -run '^TestCheckScripts'` |
## Fuzz validation
Run the bounded fuzz targets independently from the repository root. These exact
commands keep each campaign short and constrain concurrent workers:
```sh
go test ./internal/engine -run='^$' -fuzz='^FuzzParsePath$' -fuzztime=30s -parallel=2
go test ./internal/yaml -run='^$' -fuzz='^FuzzParseDocument$' -fuzztime=30s -parallel=2
go test ./internal/engine -run='^$' -fuzz='^FuzzCompositionAndOverlay$' -fuzztime=30s -parallel=2
```
` |
| Documentation links and dependency isolation | [Link checks](../documentation_test.go), [import boundary](../import_boundary_test.go), [public boundary](../public_boundary_test.go) | `go test . -run 'TestLocalDocumentationLinks\|TestDependencyImportBoundary\|TestPublicFacadeBoundary'` |
| Check-command behavior | [Shell regression](../release_check_test.go) | `go test . -run '^TestCheckScripts'` |
## Fuzz validation

23
docs/roadmap/remediation.md
View File

@@ -2,7 +2,7 @@
Review baseline: `5dc7e18`. Reviewed commits `f81def9` through `5dc7e18` against
`eb7de8e`, the agreed [roadmap](public.md), and [implementation plan](implementation.md).
Status: one open finding; F1–F3 resolved. Review evidence below describes the
Status: all four findings resolved. Review evidence below describes the
original baseline; resolution records describe the subsequent fixes.
The previous provenance finding remains resolved; its record is preserved at
@@ -150,7 +150,12 @@ no golden full-documentation snapshot is required.
## F4 — Repair the duplicated development-guide tail and table row
Priority: low. Status: open.
Priority: low. Status: resolved.
Resolution: removed the duplicate tail and stray table terminator, escaped the
boundary command's alternation pipes, and linked the new public-boundary test
owner. Content/structure review confirms one task table and one fuzz section.
The documented boundary command, documentation links, and whitespace checks pass.
### Evidence and impact
@@ -185,7 +190,17 @@ Review validation passed on Linux:
- public reference comparison and isolated baseline/current F1 reproduction;
- the isolated F2 negative probe, demonstrating the guard's missed violations.
Passing existing tests does not waive these findings. This review did not repeat
Passing existing tests did not waive these findings. The review did not repeat
the complete release checker or native macOS validation and is not release
approval. The two knowledge-graph artifact modifications present before review
were left untouched. Only this remediation document was changed in the workspace.
were left untouched. Only this remediation document was changed during review.
## Remediation completion
All four corrections are implemented and committed as coherent units. Final
validation passed on Linux: the everyday check and full race suite on Go 1.26.7,
and `go test ./...` on Go 1.25.5. The full public Go reference matches `eb7de8e`;
the new version regression was verified failing before its fix; and the original
boundary probes now fail the real boundary check and are not retained in production.
No release was prepared, and pre-existing knowledge-graph changes are not included
in remediation commits.