91 lines
3.7 KiB
Markdown
91 lines
3.7 KiB
Markdown
# Step 5 Implementation Record
|
|
|
|
## Status
|
|
|
|
Complete as of 2026-07-28.
|
|
|
|
This record summarizes the completed implementation of
|
|
[Migration Step 5: Promptkit Repository Foundation](step5.md). The
|
|
[main migration roadmap](migration.md) owns the continuing cross-repository
|
|
sequence.
|
|
|
|
## Completed Work
|
|
|
|
### Validation And Release Decision
|
|
|
|
- Added accepted
|
|
[ADR 0003](../adr/0003-use-maintainer-run-validation-and-tag-only-releases-for-promptkit.md)
|
|
for maintainer-run Promptkit validation and source-and-tag releases.
|
|
- Preserved accepted
|
|
[ADR 0002](../adr/0002-split-promptkit-from-scriptorium.md) and its repository
|
|
split, ownership, independent versioning, and release-order decisions.
|
|
- Reconciled the migration roadmap so Promptkit validation no longer depends on
|
|
hosted CI or binary packaging.
|
|
|
|
### Promptkit Module And License
|
|
|
|
- Created module `gitea.maximumdirect.net/eric/promptkit` at Go `1.25.5`.
|
|
- Added the root `promptkit` package as the only implemented Go package.
|
|
- Kept the module dependency-free and added no placeholder implementation.
|
|
- Preserved GPLv3 wording and attribution while changing the two template
|
|
example-notice project names to `Promptkit`.
|
|
- Confirmed the existing ignore rules cover Go output, editor and operating
|
|
system artifacts, `.env`, `go.work`, and `go.work.sum`.
|
|
|
|
### Policies And Architecture
|
|
|
|
- Replaced template documentation and architecture material with durable
|
|
library-specific policies.
|
|
- Assigned canonical documentation ownership, including conditional ownership
|
|
for public contracts, integrations, internal subsystems, ADRs, roadmaps, and
|
|
examples that may exist later.
|
|
- Defined the root facade, internal-package direction, consumer boundary,
|
|
exported-API discipline, error boundary, dependency injection, and repository
|
|
independence constraints for future extraction.
|
|
- Updated testing policy for deterministic, offline, parallel-safe,
|
|
behavior-focused, maintainer-run validation.
|
|
- Recorded the root package as the sole implemented component.
|
|
|
|
### Orientation, Development, And Releases
|
|
|
|
- Rewrote the Promptkit README without claiming unimplemented APIs.
|
|
- Replaced the contributor guide with task routing, complete local validation,
|
|
focused checks, and safe sibling-repository workflows.
|
|
- Added the canonical release procedure for annotated semantic Go module tags,
|
|
validation evidence, publication verification, and consumer release ordering.
|
|
- Added no hosted CI, binary packaging, executable command, or release tag.
|
|
|
|
### Cross-Repository Acceptance
|
|
|
|
Promptkit passed, without an active workspace or local replacement:
|
|
|
|
```sh
|
|
go test ./...
|
|
go vet ./...
|
|
go build ./...
|
|
gofmt -l $(git ls-files '*.go')
|
|
git diff --check
|
|
```
|
|
|
|
Acceptance also verified exact module and package metadata, all maintained
|
|
Markdown links, clean repository hygiene, the Promptkit origin and tracked
|
|
default branch, the absence of dependencies and prohibited artifacts, and the
|
|
retained GPLv3 license.
|
|
|
|
Scriptorium acceptance confirmed that ADR 0003 and the migration roadmap
|
|
distinguish Scriptorium's executable CI policy from Promptkit's maintainer-run
|
|
checks, preserve the first-tag release gate, and introduce no production code,
|
|
module dependency, workspace, or replacement change.
|
|
|
|
## Repository Boundaries
|
|
|
|
Promptkit foundation changes remain in Promptkit's Git history. Scriptorium
|
|
contains only the durable cross-project ADR and migration-roadmap records. No
|
|
tag was created and neither repository was pushed as part of this work.
|
|
|
|
## Next Work
|
|
|
|
Migration Step 6 may now extract and stabilize the application-neutral
|
|
framework. It must not update Scriptorium to consume Promptkit until Promptkit
|
|
passes its documented validation and publishes its first versioned tag.
|