diff --git a/docs/oss/attribution.md b/docs/oss/attribution.md index 120dde3..1d5ded9 100644 --- a/docs/oss/attribution.md +++ b/docs/oss/attribution.md @@ -2,9 +2,9 @@ ## Standard Repository Policies -Material: `docs/policy/release.md`, adapted from -`e833faddf120c789a9b45348edaf75720de16348`; `docs/policy/meta.md`, `docs/policy/oss.md`, -`docs/policy/documentation.md`, `docs/policy/agents.md`, +Material: `docs/policy/documentation.md`, `docs/policy/oss.md`, and +`docs/policy/release.md`, adapted from +`b339ad0427a50e43a68b932a6a9f4669cc0f6252`; `docs/policy/meta.md`, `docs/policy/agents.md`, `docs/policy/architecture.md`, `docs/policy/testing.md`; root `AGENTS.md`; and the Policy Reading Guide in `docs/development.md`, adapted from `d84a38ebab26f048cafbe59a2246700c35d29843` for this repository. @@ -16,12 +16,12 @@ SPDX-License-Identifier: CC-BY-SA-4.0 License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) | [COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/COPYRIGHT) | [LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/LICENSE) | -[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/COPYRIGHT) | -[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/LICENSE). +[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/b339ad0427a50e43a68b932a6a9f4669cc0f6252/COPYRIGHT) | +[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/b339ad0427a50e43a68b932a6a9f4669cc0f6252/LICENSE). [Source](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843). -[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348). +[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/b339ad0427a50e43a68b932a6a9f4669cc0f6252). ## go-yaml v4 diff --git a/docs/policy/documentation.md b/docs/policy/documentation.md index 7d69866..ec66e7c 100644 --- a/docs/policy/documentation.md +++ b/docs/policy/documentation.md @@ -1,10 +1,10 @@ # Documentation Policy -**Base Policy Version:** 1.11 +**Base Policy Version:** 1.12 -**Last Updated**: 2026-10-16 +**Last Updated**: 2026-11-09 -**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/b339ad0427a50e43a68b932a6a9f4669cc0f6252/docs/policy/documentation.md) ## Purpose @@ -91,7 +91,7 @@ secret values. | Consumer guidance for the public Go API | `docs/consumers/` | Task-oriented public Go API usage, minimal examples, and consumer responsibilities. | Go symbol contracts, configuration semantics, and internal implementation detail. | | 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. | -| 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/` | Records of significant architectural decisions and supporting rationale. | Ordinary design choices, current behavior reference, implementation status, task sequencing. | | 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. | | 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. | @@ -157,10 +157,16 @@ Use sequentially numbered ADR filenames such as 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. + +ADRs should be reserved for major architectural decisions, such as ownership +boundaries, large-scale architectural features, or invariants that rise to +the level of architectural significance. Routine choices, implementation +decisions, and rejected suggestions do not warrant an ADR unless they +otherwise represent a significant architectural decision. + Rejected architectural alternatives and significant architectural exclusions 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. +ideas. ## Maintenance diff --git a/docs/policy/oss.md b/docs/policy/oss.md index ef2981e..68e419b 100644 --- a/docs/policy/oss.md +++ b/docs/policy/oss.md @@ -1,10 +1,10 @@ # Open Source Licensing And Attribution Policy -**Base Policy Version:** 1.8 +**Base Policy Version:** 1.9 -**Last Updated**: 2026-09-28 +**Last Updated**: 2026-11-09 -**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/oss.md) +**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/b339ad0427a50e43a68b932a6a9f4669cc0f6252/docs/policy/oss.md) ## ConfigKit Applicability @@ -74,8 +74,9 @@ individual packages. Use the upstream [application COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/application/COPYRIGHT) or [library COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/library/COPYRIGHT) -to create the project’s root `COPYRIGHT` file. -Use verified project names, contribution years, and copyright holders. +to create the project’s root `COPYRIGHT` file. Use the examples as provided, +without discretionary modification, unless otherwise instructed. Substitute +verified project names, contribution years, and copyright holders. For another selected license, adapt the grant, SPDX expression, disclaimer, and text references together to reflect the author's selected grant. diff --git a/docs/policy/release.md b/docs/policy/release.md index a61a342..ac10d8a 100644 --- a/docs/policy/release.md +++ b/docs/policy/release.md @@ -1,10 +1,10 @@ # Release Policy -**Base Policy Version:** 1.6 +**Base Policy Version:** 1.7 -**Last Updated**: 2026-10-09 +**Last Updated**: 2026-11-09 -**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md) +**Upstream Source:** [Standard Repository Policies](https://gitea.maximumdirect.net/eric/policy/src/commit/b339ad0427a50e43a68b932a6a9f4669cc0f6252/docs/policy/release.md) ## Purpose @@ -110,6 +110,10 @@ For releases at or after `v1.0.0`: minimum as described below; and - a patch release may make backward-compatible fixes. +In this context, "backward-compatible" means only that pre-existing, valid +configurations will continue to work following the release. Behavior need not +remain strictly identical. + Before `v1.0.0`, a minor release may change a documented public, operational, configuration, data, integration, or compatibility contract when the release note explains the impact and required consumer action. A patch release must