Record ConfigKit adoption review finding
This commit is contained in:
@@ -1,13 +1,72 @@
|
||||
# Promptkit Upgrade Review Remediation
|
||||
# Implementation Review Remediation
|
||||
|
||||
## Scope And Status
|
||||
## ConfigKit v0.5.0 Review
|
||||
|
||||
Reviewed on 2026-10-03 at `bcf2ddf`, covering the five implementation
|
||||
commits after `e1ce526`. The ConfigKit adoption and runtime ownership
|
||||
boundaries match the accepted roadmap. No runtime defect, missing application
|
||||
feature, or unrequested strengthening of contracts was identified. One
|
||||
documentation handoff issue remains open below.
|
||||
|
||||
### R2: Correct The Completed Plan's Introductory Status
|
||||
|
||||
Priority: P3 (low). Status: Open.
|
||||
|
||||
Location: `docs/roadmap/implementation.md:5–9`.
|
||||
|
||||
The introduction still says "All five stages are pending" and directs the
|
||||
reader to implement Stage 1 through Stage 5. Each stage is actually marked
|
||||
Complete with completion evidence, and the feature roadmap identifies the
|
||||
adoption as delivered. These contradictory directions leave the overall
|
||||
handoff inaccurate and could lead a later coding agent to repeat completed
|
||||
work.
|
||||
|
||||
This is a completion-documentation issue, not an unfinished runtime feature.
|
||||
The [documentation policy](../policy/documentation.md) assigns implementation
|
||||
status to roadmaps; the overall status should agree with the stage evidence.
|
||||
|
||||
Required change: update the introduction to state that all five stages are
|
||||
complete. Describe the retained steps as implementation history and acceptance
|
||||
evidence rather than instructions to start the work again. Preserve the
|
||||
original planning baseline, completed stage records, deferred scope, and
|
||||
separate release handoff. Do not change application code or rerun the feature
|
||||
implementation to repair the wording.
|
||||
|
||||
Acceptance: the overall status, individual stages, and feature roadmap agree
|
||||
that implementation is complete, while release preparation remains separate.
|
||||
Review the documentation diff and run `git diff --check`; this correction
|
||||
does not require new tests.
|
||||
|
||||
### Review Verification
|
||||
|
||||
- `go test -race -count=1 ./...` passed, including the new configuration,
|
||||
inspection, and engine-adoption tests and existing shared-capacity coverage.
|
||||
- `go vet ./...`, a native build outside the repository, and diff checks passed.
|
||||
- All five maintained inheritance example commands succeeded with
|
||||
`LOCAL_GPU_API_KEY` absent: validate, show, sources, explain, and render.
|
||||
The child selected its own backend ID with the inherited endpoint, zero queue
|
||||
capacity and false parameter remained explicit, and explanation retained
|
||||
the parent/destination/directive relationship.
|
||||
- Changed upstream documentation and notice links, affected local paths,
|
||||
and the historical policy-plan reference resolved.
|
||||
- The work set changes dependency pins, tests, examples, and documentation;
|
||||
no production Go implementation was changed. ConfigKit v0.5.0 owns inheritance
|
||||
through the existing single-load integration; Promptkit remains v0.11.2.
|
||||
- The `extends` reservation is the explicitly accepted upstream compatibility
|
||||
change, not a new Scriptorium restriction. Parameter and credential-reference
|
||||
visibility, working-directory-relative paths, ordinary parent registration,
|
||||
and existing shared server capacity remain as selected.
|
||||
|
||||
## Earlier Promptkit Upgrade Review (Resolved)
|
||||
|
||||
### Scope And Status
|
||||
|
||||
Review baseline: `e177d7c`, covering implementation commits after `5c3b0cf`.
|
||||
This document records a resolved test-contract issue; it does not authorize
|
||||
unrelated implementation changes. No runtime defect or missing planned feature
|
||||
was identified in this review. Release preparation remains separate work.
|
||||
|
||||
## R1: Remove The Unrequested Context-Identity Invariant
|
||||
### R1: Remove The Unrequested Context-Identity Invariant
|
||||
|
||||
Priority: P3 (low). Status: Complete.
|
||||
|
||||
@@ -27,7 +86,7 @@ invariant, contrary to the [agent policy](../policy/agents.md) and
|
||||
[testing policy](../policy/testing.md). The current handler's context behavior
|
||||
is correct; this is a maintainability issue, not a runtime cancellation bug.
|
||||
|
||||
### Required Change
|
||||
#### Required Change
|
||||
|
||||
Remove the identity comparison and the identity-only table field. Retain
|
||||
behavioral assertions that an earlier parent deadline is not extended and
|
||||
@@ -40,7 +99,7 @@ Use the existing runner seam and focused cases; do not introduce a context
|
||||
wrapper framework, timer abstraction, new public guarantee, or production
|
||||
refactor solely to change this test.
|
||||
|
||||
### Completion Criteria
|
||||
#### Completion Criteria
|
||||
|
||||
- Tests protect effective deadline/cancellation behavior without requiring
|
||||
context object identity.
|
||||
@@ -48,7 +107,7 @@ refactor solely to change this test.
|
||||
is a different object.
|
||||
- Existing timeout validation and HTTP outcome coverage remains intact.
|
||||
|
||||
### Resolution And Validation
|
||||
#### Resolution And Validation
|
||||
|
||||
Removed the identity-only table field and context comparisons. The test now
|
||||
checks effective deadlines, including omitted/null/zero requests with no
|
||||
@@ -60,7 +119,7 @@ Focused HTTP timeout tests, `go test ./...`, `go test -race ./...`,
|
||||
`go vet ./...`, a native build outside the repository, and `git diff --check`
|
||||
all passed after remediation.
|
||||
|
||||
## Original Review Verification
|
||||
### Original Review Verification
|
||||
|
||||
- `go test -race -count=1 ./...` passed, including retry, shared-capacity,
|
||||
deadline, report, definition-conformance, and architecture-boundary tests.
|
||||
|
||||
Reference in New Issue
Block a user