Retire deferred scope and preserve future performance experiments
This commit is contained in:
@@ -66,7 +66,8 @@ owns the detailed combination rules and input-specific constraints.
|
|||||||
|
|
||||||
The [architecture goals](docs/policy/architecture.md#success-criteria) explain
|
The [architecture goals](docs/policy/architecture.md#success-criteria) explain
|
||||||
these priorities and how genuine new needs can justify extending the shared
|
these priorities and how genuine new needs can justify extending the shared
|
||||||
model. The [deferred scope](docs/roadmap/deferred.md) records deliberate exclusions.
|
model. The [future feature list](docs/roadmap/future.md) preserves candidates for
|
||||||
|
consideration in future releases.
|
||||||
|
|
||||||
The [configuration contract](docs/config.md) describes implemented behavior,
|
The [configuration contract](docs/config.md) describes implemented behavior,
|
||||||
including [input destinations](docs/config.md#input-destinations). The
|
including [input destinations](docs/config.md#input-destinations). The
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ public behavior.
|
|||||||
| Shared source-version checks | [Configuration contract](config.md#shared-source-version-checks), [ADR 0013](adr/0013-shared-source-version-checks.md), and the version/source-version tests below |
|
| Shared source-version checks | [Configuration contract](config.md#shared-source-version-checks), [ADR 0013](adr/0013-shared-source-version-checks.md), and the version/source-version tests below |
|
||||||
| Documentation changes | The owning document |
|
| Documentation changes | The owning document |
|
||||||
| Licensing, dependencies, attribution, or release-document changes | [Project grant](../COPYRIGHT) and [attribution](oss/attribution.md); release changes also follow the release procedure |
|
| Licensing, dependencies, attribution, or release-document changes | [Project grant](../COPYRIGHT) and [attribution](oss/attribution.md); release changes also follow the release procedure |
|
||||||
| Architecture decisions or future work | [Deferred scope](roadmap/deferred.md) and relevant ADRs listed below |
|
| Architecture decisions or future work | [Future features](roadmap/future.md) and relevant ADRs listed below |
|
||||||
| Code and test changes | The owning contract and tests from the map below |
|
| Code and test changes | The owning contract and tests from the map below |
|
||||||
| Examples or copyable assets | The owning implemented contract and [consumer adoption guide](consumers/README.md) |
|
| Examples or copyable assets | The owning implemented contract and [consumer adoption guide](consumers/README.md) |
|
||||||
| Release preparation | [Release procedure](release.md) |
|
| Release preparation | [Release procedure](release.md) |
|
||||||
@@ -108,7 +108,7 @@ git show 8e91a2b:docs/roadmap/startup-benchmark.md
|
|||||||
```
|
```
|
||||||
|
|
||||||
Remaining optimization candidates belong to
|
Remaining optimization candidates belong to
|
||||||
[deferred scope](roadmap/deferred.md#deferred-performance-experiments).
|
[future performance experiments](roadmap/future.md#3-performance-experiments).
|
||||||
|
|
||||||
The completed effective-configuration diff roadmap, implementation plan, and
|
The completed effective-configuration diff roadmap, implementation plan, and
|
||||||
resolved review findings are preserved in Git history at `1c2610c` under
|
resolved review findings are preserved in Git history at `1c2610c` under
|
||||||
@@ -131,7 +131,7 @@ Current behavior belongs to the configuration contract's
|
|||||||
[input destinations](config.md#input-destinations),
|
[input destinations](config.md#input-destinations),
|
||||||
[imports](config.md#explicit-imports), and
|
[imports](config.md#explicit-imports), and
|
||||||
[shared source-version checks](config.md#shared-source-version-checks) sections.
|
[shared source-version checks](config.md#shared-source-version-checks) sections.
|
||||||
Possible follow-ups remain in [deferred scope](roadmap/deferred.md).
|
Potential enhancements are tracked in [future features](roadmap/future.md).
|
||||||
|
|
||||||
Install the Go version required by `go.mod` or a compatible newer toolchain.
|
Install the Go version required by `go.mod` or a compatible newer toolchain.
|
||||||
Acquire declared dependencies explicitly before entering an offline
|
Acquire declared dependencies explicitly before entering an offline
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
**Base Policy Version:** 1.3
|
**Base Policy Version:** 1.3
|
||||||
|
|
||||||
**Last Updated**: 2026-09-29
|
**Last Updated**: 2026-10-16
|
||||||
|
|
||||||
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/architecture.md)
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/architecture.md)
|
||||||
|
|
||||||
@@ -19,8 +19,8 @@ to ADRs for decision rationale.
|
|||||||
ConfigKit is an opinionated Go library for consistent YAML configuration loading
|
ConfigKit is an opinionated Go library for consistent YAML configuration loading
|
||||||
and resolution across consuming applications. The [component overview](../internal/overview.md)
|
and resolution across consuming applications. The [component overview](../internal/overview.md)
|
||||||
owns implementation inventory, the [configuration contract](../config.md) owns
|
owns implementation inventory, the [configuration contract](../config.md) owns
|
||||||
implemented behavior, and the [deferred scope](../roadmap/deferred.md) preserves
|
implemented behavior, and the [future feature list](../roadmap/future.md) preserves
|
||||||
deferred scope.
|
candidates for future consideration.
|
||||||
|
|
||||||
## Adopted Constraints And Implemented Structure
|
## Adopted Constraints And Implemented Structure
|
||||||
|
|
||||||
@@ -243,7 +243,7 @@ for safe messages supplied by their hooks.
|
|||||||
Do not introduce automatic directory discovery, network providers, arbitrary
|
Do not introduce automatic directory discovery, network providers, arbitrary
|
||||||
merge strategies, additional configuration languages, or application runtime
|
merge strategies, additional configuration languages, or application runtime
|
||||||
management without concrete consumer evidence and an explicit design decision.
|
management without concrete consumer evidence and an explicit design decision.
|
||||||
The [deferred scope](../roadmap/deferred.md#explicit-non-goals-and-deferred-scope)
|
Record significant decisions to exclude capabilities, and their rationale, in
|
||||||
owns the deferred-feature inventory. Significant boundary
|
ADRs. Significant boundary changes require an ADR and corresponding
|
||||||
changes require an ADR and corresponding policy/contract updates; implementation
|
policy/contract updates; implementation convenience alone is not a reason to
|
||||||
convenience alone is not a reason to broaden the public API.
|
broaden the public API.
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
**Base Policy Version:** 1.11
|
**Base Policy Version:** 1.11
|
||||||
|
|
||||||
**Last Updated**: 2026-09-28
|
**Last Updated**: 2026-10-16
|
||||||
|
|
||||||
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/documentation.md)
|
**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/documentation.md)
|
||||||
|
|
||||||
@@ -38,9 +38,10 @@ roadmap owns implementation status and sequencing until the decision is
|
|||||||
implemented. Current architecture, user, operator, integration, and internal
|
implemented. Current architecture, user, operator, integration, and internal
|
||||||
documentation are updated when the behavior lands.
|
documentation are updated when the behavior lands.
|
||||||
|
|
||||||
`docs/roadmap/deferred.md` owns deliberate exclusions; task-specific plans
|
`docs/roadmap/future.md` owns potential enhancements and their open questions;
|
||||||
own execution order and progress. Completed plans retire during release
|
task-specific plans own execution order and progress. Record significant
|
||||||
preparation.
|
architectural exclusions and their rationale in ADRs. Do not maintain a roadmap
|
||||||
|
inventory of rejected proposals. Completed plans retire during release preparation.
|
||||||
|
|
||||||
### Audience And Detail
|
### Audience And Detail
|
||||||
|
|
||||||
@@ -91,7 +92,7 @@ secret values.
|
|||||||
| Inventory of implemented internal packages | `docs/internal/overview.md` | Implemented packages and components, responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
| Inventory of implemented internal packages | `docs/internal/overview.md` | Implemented packages and components, responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
||||||
| Behavior and architecture of internal packages | Other files under `docs/internal/` | Implementation flow, collaborators, state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
| Behavior and architecture of internal packages | Other files under `docs/internal/` | Implementation flow, collaborators, state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
||||||
| Architectural decision records | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. |
|
| Architectural decision records | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. |
|
||||||
| Deferred scope | `docs/roadmap/deferred.md` | Deliberate exclusions and conditions for reconsideration. | Task execution and current behavior. |
|
| Potential future features | `docs/roadmap/future.md` | Candidate enhancements and open questions for future consideration. | Rejected proposals, architectural decisions, task execution, and current behavior. |
|
||||||
| Future implementation plans | Task-specific files under `docs/roadmap/` | Unfinished work, sequencing, acceptance, and progress; completed plans retire during release preparation. | Implemented behavior and ADR rationale. |
|
| Future implementation plans | Task-specific files under `docs/roadmap/` | Unfinished work, sequencing, acceptance, and progress; completed plans retire during release preparation. | Implemented behavior and ADR rationale. |
|
||||||
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
| Release-note history | `docs/releases/` | One checked-in summary per source release under the procedure; the note at its immutable tag is the release record. | Current commands, behavior, contracts, and compatibility definitions. |
|
||||||
| Complete examples | `examples/` and executable Go examples | Maintained copyable artifacts and Go API examples. | Configuration reference, symbol contracts, and prose explanation. |
|
| Complete examples | `examples/` and executable Go examples | Maintained copyable artifacts and Go API examples. | Configuration reference, symbol contracts, and prose explanation. |
|
||||||
@@ -156,8 +157,10 @@ Use sequentially numbered ADR filenames such as
|
|||||||
|
|
||||||
Treat the decision content of an accepted ADR as immutable. When a decision
|
Treat the decision content of an accepted ADR as immutable. When a decision
|
||||||
changes, create a new ADR and update the earlier ADR's status to superseded.
|
changes, create a new ADR and update the earlier ADR's status to superseded.
|
||||||
Rejected architectural alternatives belong in the ADR; rejected product ideas
|
Rejected architectural alternatives and significant architectural exclusions
|
||||||
belong in the roadmap. Routine choices need no ADR.
|
belong in ADRs. Roadmaps preserve plausible future work, not rejected product
|
||||||
|
ideas. Routine choices and rejected suggestions need no ADR unless they
|
||||||
|
represent a significant architectural decision.
|
||||||
|
|
||||||
## Maintenance
|
## Maintenance
|
||||||
|
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ adopts ReleaseKit for source publication, and raises the consumer Go minimum to
|
|||||||
successful-tag-push completion point remain unchanged; CI is not a gate.
|
successful-tag-push completion point remain unchanged; CI is not a gate.
|
||||||
- Adopt release policy 1.6, distinguishing the consumer Go minimum from the
|
- Adopt release policy 1.6, distinguishing the consumer Go minimum from the
|
||||||
validation toolchain. Retire completed planning and measurement records into
|
validation toolchain. Retire completed planning and measurement records into
|
||||||
Git history while preserving [deferred work](../roadmap/deferred.md).
|
Git history while preserving [performance candidates](../roadmap/future.md#3-performance-experiments).
|
||||||
|
|
||||||
## Compatibility and upgrade
|
## Compatibility and upgrade
|
||||||
|
|
||||||
|
|||||||
@@ -1,71 +0,0 @@
|
|||||||
# Deferred Scope
|
|
||||||
|
|
||||||
This document owns intentionally excluded features, not a committed delivery plan.
|
|
||||||
The [future feature list](future.md) preserves candidate enhancements and open
|
|
||||||
questions without changing these exclusions.
|
|
||||||
The [architecture policy](../policy/architecture.md) governs changes to these
|
|
||||||
boundaries. Implemented behavior belongs in the [configuration contract](../config.md)
|
|
||||||
and consumer adoption in the [consumer guide](../consumers/README.md).
|
|
||||||
|
|
||||||
## Explicit non-goals and deferred scope
|
|
||||||
|
|
||||||
General environment-variable configuration overlays are not supported. Typed secret
|
|
||||||
references and explicit directory bootstrap are the environment convention. Literal
|
|
||||||
credential configuration and implicit secret-directory discovery are unsupported.
|
|
||||||
|
|
||||||
The following remain deliberately excluded:
|
|
||||||
|
|
||||||
- automatic `conf.d` discovery;
|
|
||||||
- remote imports, arbitrary providers, and additional configuration formats;
|
|
||||||
- custom merge strategies, sequence merging, reset operators, multiple-parent
|
|
||||||
inheritance, and cross-scope references;
|
|
||||||
- named overlay inheritance;
|
|
||||||
- parser-specific or custom structural-decoding extension APIs;
|
|
||||||
- generic dynamic-subtree conversion and module-registry APIs;
|
|
||||||
- automatic schema migrations;
|
|
||||||
- hot reload, runtime resource replacement, and remote resource validation;
|
|
||||||
- a bundled CLI framework or application commands; and
|
|
||||||
- configuration fingerprints.
|
|
||||||
|
|
||||||
Applications may build their own validate, effective-value, source, bootstrap, and
|
|
||||||
explanation commands around the library. Broadening these boundaries requires
|
|
||||||
concrete consumer evidence, compatibility review, and an explicit design change.
|
|
||||||
|
|
||||||
Effective configuration diffs are implemented over frozen successful-load
|
|
||||||
inspections; their current comparison and disclosure contract is in the
|
|
||||||
[configuration contract](../config.md#effective-configuration-diffs), with
|
|
||||||
consumer workflows in the [adoption guide](../consumers/README.md#effective-configuration-diffs).
|
|
||||||
Fingerprints remain deferred.
|
|
||||||
|
|
||||||
Built-in sibling inheritance using `extends` is implemented as described in the
|
|
||||||
[configuration contract](../config.md#sibling-inheritance). It is distinct from
|
|
||||||
inheritance between selected overlay files, which remains excluded above.
|
|
||||||
|
|
||||||
## Possible source-version follow-ups
|
|
||||||
|
|
||||||
Independent collection or subtree specification policies were outside the
|
|
||||||
completed shared source-version feature and remain possible future work, with
|
|
||||||
no committed delivery plan. Current [source-version checks](../config.md#shared-source-version-checks)
|
|
||||||
use one application-owned policy across participating documents. Reconsider
|
|
||||||
independent policies if concrete consumer needs justify a separate design
|
|
||||||
decision; this is not a permanent prohibition. The original request and its
|
|
||||||
selected scope remain at `e4270c9:docs/roadmap/promptkit-feature-request.md` in
|
|
||||||
Git history. Existing sequence-composition and cross-scope inheritance deferrals
|
|
||||||
above also remain unchanged.
|
|
||||||
|
|
||||||
## Deferred performance experiments
|
|
||||||
|
|
||||||
The completed performance audit left these internal optimization candidates for
|
|
||||||
separate investigation:
|
|
||||||
|
|
||||||
- branch-local explanation replay instead of the current whole-tree replay;
|
|
||||||
- redesigning the private metadata-copy handoff while preserving detached public
|
|
||||||
records;
|
|
||||||
- caching schema descriptors across loads; and
|
|
||||||
- indexing complex contributor-trace membership while preserving its equality
|
|
||||||
rules and compact linked traces.
|
|
||||||
|
|
||||||
These are not committed implementation work. Reconsider them with evidence that
|
|
||||||
the benefit justifies the ownership, retained-memory, or equivalence risks. The
|
|
||||||
completed audit and implementation evidence are preserved in Git history at
|
|
||||||
`8e91a2b` under `docs/roadmap/`.
|
|
||||||
@@ -2,8 +2,9 @@
|
|||||||
|
|
||||||
This document lists potential enhancements for consideration in future ConfigKit
|
This document lists potential enhancements for consideration in future ConfigKit
|
||||||
releases. Entries are not accepted contracts, implementation plans, or release
|
releases. Entries are not accepted contracts, implementation plans, or release
|
||||||
commitments. [Deferred scope](deferred.md) remains the owner of current exclusions;
|
commitments. Adopting a candidate requires an explicit design decision and a
|
||||||
adopting a candidate requires an explicit design decision and a separate plan.
|
separate plan. Significant architectural exclusions and their rationale belong
|
||||||
|
in ADRs; this document does not maintain a list of rejected proposals.
|
||||||
|
|
||||||
## 1. Identified record sequences
|
## 1. Identified record sequences
|
||||||
|
|
||||||
@@ -130,3 +131,31 @@ compatible version or replace final configuration validation.
|
|||||||
reader, byte, and mapping inputs, glob matches, and repeated imports? Define
|
reader, byte, and mapping inputs, glob matches, and repeated imports? Define
|
||||||
behavior for absent optional inputs and preserve source-local diagnostics,
|
behavior for absent optional inputs and preserve source-local diagnostics,
|
||||||
inspection evidence, and existing sensitivity handling.
|
inspection evidence, and existing sensitivity handling.
|
||||||
|
|
||||||
|
## 3. Performance experiments
|
||||||
|
|
||||||
|
Status: deferred pending evidence. The completed performance audit identified
|
||||||
|
four internal optimization candidates for separate investigation:
|
||||||
|
|
||||||
|
- Branch-local explanation replay instead of the current whole-tree replay.
|
||||||
|
- Redesigning the private metadata-copy handoff while preserving detached public
|
||||||
|
records.
|
||||||
|
- Caching schema descriptors across loads.
|
||||||
|
- Indexing complex contributor-trace membership while preserving its equality
|
||||||
|
rules and compact linked traces.
|
||||||
|
|
||||||
|
These are experiments, not committed implementation work or promised speedups.
|
||||||
|
Reconsider them with evidence that the benefit justifies the ownership,
|
||||||
|
retained-memory, or equivalence risks. The completed audit and implementation
|
||||||
|
evidence are preserved in Git history at `8e91a2b` under `docs/roadmap/`.
|
||||||
|
|
||||||
|
### Questions to resolve before implementation
|
||||||
|
|
||||||
|
- Which representative workloads show enough remaining cost to justify each
|
||||||
|
optimization, and what measurements would establish a useful improvement?
|
||||||
|
- Can narrower replay and membership indexes preserve explanation results,
|
||||||
|
ordering, provenance, and sensitivity behavior?
|
||||||
|
- Can metadata handoff changes preserve detached public records and ownership
|
||||||
|
across loads without introducing aliasing?
|
||||||
|
- What cache lifetime and concurrency design would make schema reuse worthwhile
|
||||||
|
without excessive retained memory?
|
||||||
|
|||||||
Reference in New Issue
Block a user