Files
promptkit/docs/roadmap/next-release-considerations.md

2.7 KiB

Feature Considerations Before The Next Release

Status: item 1 records accepted design decisions; item 2 remains a discussion candidate. Review these items before the next release; this document does not authorize implementation or commit either item to that release. Implemented schema support is documented in the format reference.

1. Enable One Structured-Output Repair Attempt By Default

Accepted: default to one repair attempt for every validation mode that supports repair. This gives structurally invalid or empty output one automatic correction opportunity without requiring each consumer to opt in.

Validation mode Default repair attempts
none 0
basic 1
json 1
json_schema 1

Use a presence-aware public RepairAttempts field: omission selects the mode's default; explicit zero disables repairs. Retain explicit budgets of two or three for eligible modes. Keep the existing rejection of positive budgets for none. Choose one rather than two as the default; consumers can opt into another correction opportunity when appropriate for their workloads.

Apply defaults after ConfigKit composition, preserving explicit values. Execution and inspection use the resolved concrete budget. Apply the same mode defaults to omitted runtime output-contract budgets; runtime contracts still replace the configured contract completely. Prepared execution retains its resolved budget.

Implementation planning must specify the presence-aware Go shape and migration from the current integer field, and cover omission versus explicit zero across configuration, typed helpers, and runtime contracts. Document that repair runs only after failed validation and can add generation latency and usage. Existing repair accounting, exhaustion, cancellation, and transient-retry semantics remain unchanged; the change does not promise successful correction.

2. Place Configuration Under A Root-Level promptkit Key

Consider moving PromptKit-owned configuration beneath promptkit, for example from prompts to promptkit.prompts. This would give applications a distinct configuration section for PromptKit alongside their other settings.

Before accepting, settle:

  • The complete field scope, including backends, profiles, collections, and schema roots; ConfigKit-owned source headers and directives retain ConfigKit semantics.
  • Whether to make a clean breaking migration or support a transition period.
  • How collection imports, bundled defaults, typed configuration helpers, and inspection use the new location through normal ConfigKit composition.
  • Migration guidance accounting for the implemented schema-source changes.

Further Candidates

Append additional pre-release considerations here as they arise.