From 2be7bbc015d887e490d3c4db8f8f6bcde7e1f8b6 Mon Sep 17 00:00:00 2001 From: Eric Rakestraw Date: Wed, 11 Nov 2026 14:44:06 +0000 Subject: [PATCH] Adopt the updated repository policies --- docs/oss/attribution.md | 18 +++++++----------- docs/policy/documentation.md | 10 +++++----- docs/policy/oss.md | 15 +++++++++------ docs/policy/release.md | 14 +++++++++++--- 4 files changed, 32 insertions(+), 25 deletions(-) diff --git a/docs/oss/attribution.md b/docs/oss/attribution.md index 7cba9c9..d7dbc01 100644 --- a/docs/oss/attribution.md +++ b/docs/oss/attribution.md @@ -4,10 +4,10 @@ Material: All documents under `docs/policy/`, root `AGENTS.md`, and the Policy Reading Guide in `docs/development.md`, adapted for this repository. -`docs/policy/release.md` incorporates revision -`e833faddf120c789a9b45348edaf75720de16348`; `docs/policy/documentation.md` -incorporates revision `beb5f191470a9daef2383981a6bfd02232490ab4`; the remaining listed material -incorporates revision `d84a38ebab26f048cafbe59a2246700c35d29843`. +`docs/policy/documentation.md`, `docs/policy/oss.md`, and `docs/policy/release.md` +incorporate revision `593c9b52273c5c879785ae9e995d21026df467b4`. +The remaining listed material incorporates revision +`d84a38ebab26f048cafbe59a2246700c35d29843`. Copyright (C) 2026 Eric Rakestraw @@ -16,16 +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/beb5f191470a9daef2383981a6bfd02232490ab4/COPYRIGHT) | -[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/beb5f191470a9daef2383981a6bfd02232490ab4/LICENSE). +[COPYRIGHT](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/COPYRIGHT) | +[LICENSE](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/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/beb5f191470a9daef2383981a6bfd02232490ab4). +[Source](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4). ## ConfigKit diff --git a/docs/policy/documentation.md b/docs/policy/documentation.md index a4dcafd..fac7c31 100644 --- a/docs/policy/documentation.md +++ b/docs/policy/documentation.md @@ -1,9 +1,9 @@ # Documentation Policy -**Base Policy Version:** 1.11 +**Base Policy Version:** 1.12 -**Last Updated**: 2026-11-08 -**Upstream Source:** [Standard Repository Policies documentation](https://gitea.maximumdirect.net/eric/policy/src/commit/beb5f191470a9daef2383981a6bfd02232490ab4/docs/policy/documentation.md) +**Last Updated**: 2026-11-11 +**Upstream Source:** [Standard Repository Policies documentation](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/documentation.md) ## Purpose @@ -85,8 +85,8 @@ 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. | | 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. | | Contributor change recipes | Relevant files under `docs/internal/`, including `docs/internal/cli-config.md`, `docs/internal/modules.md`, and `docs/internal/validators.md` | Concrete editing and validation steps for each component. | Contributor orientation, global policy, and definitions of external contracts. | -| Architectural decision records | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. | -| Future work and implementation status | `docs/roadmap/` | Proposed, accepted, or deferred work; implementation status, sequencing, and task breakdowns. | Implemented behavior reference and architectural decision rationale. | +| Architectural decision records | `docs/adr/` | Records of significant architectural decisions and supporting rationale. | Ordinary design choices, current behavior reference, implementation status, task sequencing. | +| Future work and implementation status | `docs/roadmap/` | Proposed, accepted, or future work; implementation status, sequencing, and task breakdowns. | Implemented behavior reference and architectural decision 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. | | Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other copyable or runnable files. | Field-by-field reference, command reference, prose explanation. | diff --git a/docs/policy/oss.md b/docs/policy/oss.md index 04296f9..a2c57ef 100644 --- a/docs/policy/oss.md +++ b/docs/policy/oss.md @@ -1,9 +1,9 @@ # Open Source Licensing And Attribution Policy -**Base Policy Version:** 1.8 +**Base Policy Version:** 1.9 -**Last Updated**: 2026-09-28 -**Upstream Source:** [Standard Repository Policies oss](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/docs/policy/oss.md) +**Last Updated**: 2026-11-11 +**Upstream Source:** [Standard Repository Policies oss](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/oss.md) ## Purpose And Scope @@ -64,9 +64,12 @@ license unless the author deliberately changes it. For mixed-purpose projects, follow the author's selected scope rather than inferring different licenses for 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) +Use the upstream [application COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/application/COPYRIGHT) +or [library COPYRIGHT example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/library/COPYRIGHT) to create the project’s root `COPYRIGHT` file. +Use the COPYRIGHT examples exactly as provided, except for placeholder +substitutions and changes expressly required or authorized by this policy or +the author. Use 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. @@ -113,7 +116,7 @@ Each entry presents these five fields in order, with blank lines between them: filenames, such as `COPYRIGHT`, `LICENSE`, `NOTICE`, or `PATENTS`. 5. **Source repository link**, rendered exactly as `[Source](COMMIT_URL).`. -Use the upstream [attribution example](https://gitea.maximumdirect.net/eric/policy/src/commit/d84a38ebab26f048cafbe59a2246700c35d29843/examples/licensing/attribution.md) +Use the upstream [attribution example](https://gitea.maximumdirect.net/eric/policy/src/commit/a469273adda336625f96b9d769ea27b33999f146/examples/licensing/attribution.md) to create the project’s `docs/oss/attribution.md`. The example illustrates omitted fields and multiple copyrights and licenses. Replace the uppercase placeholders and illustrative URLs with actual component diff --git a/docs/policy/release.md b/docs/policy/release.md index 1fb43c2..42b13f5 100644 --- a/docs/policy/release.md +++ b/docs/policy/release.md @@ -1,9 +1,9 @@ # Release Policy -**Base Policy Version:** 1.6 +**Base Policy Version:** 1.7 -**Last Updated**: 2026-10-08 -**Upstream Source:** [Standard Repository Policies release](https://gitea.maximumdirect.net/eric/policy/src/commit/e833faddf120c789a9b45348edaf75720de16348/docs/policy/release.md) +**Last Updated**: 2026-11-11 +**Upstream Source:** [Standard Repository Policies release](https://gitea.maximumdirect.net/eric/policy/src/commit/593c9b52273c5c879785ae9e995d21026df467b4/docs/policy/release.md) ## Purpose @@ -82,6 +82,14 @@ 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. + +Audita's minor and patch releases also preserve the documented +[subprocess integration](../integrations/subprocess.md) and +[output-file](../integrations/output-files.md) contracts. + 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