From 54e17d5ea683a598dd35f274d53a6b40e3d0f8c6 Mon Sep 17 00:00:00 2001 From: Brian Faust Date: Mon, 7 Sep 2026 13:27:20 +0300 Subject: [PATCH] docs(router): align support and release guidance Describe the stable root module and direct reporting routes so consumers see policy matching the published v1 repository. Impact: patch --- CHANGELOG.md | 5 ++++- COMPATIBILITY.md | 11 ++++------- SECURITY.md | 9 +++++---- SUPPORT.md | 20 ++++++++++++-------- 4 files changed, 25 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8036885..659e2d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,9 @@ Versioning. ### Documentation +- Align the root-module tag syntax, stable-v1 support boundary, and private + security-reporting route with the published repository, and correct the + initial release date to its verified tag and release chronology. - Clarify the stable v1 support baseline and canonical installation command, expose support and vulnerability-reporting entry points, and correct the security advisory repository identity. @@ -70,7 +73,7 @@ Versioning. - Record RFC 9110 Erratum 9162 as behavior-neutral because generated `Allow` field values already use comma-space separation. -## [1.0.0] - 2026-08-25 +## [1.0.0] - 2026-08-26 ### Fixed diff --git a/COMPATIBILITY.md b/COMPATIBILITY.md index 1203cc0..8dcf1f3 100644 --- a/COMPATIBILITY.md +++ b/COMPATIBILITY.md @@ -1,12 +1,9 @@ # Compatibility Policy -Each releasable directory is an independent Go module and follows semantic -versioning. Tags use `/v`. - -Before `v1`, minor releases MAY contain reviewed breaking changes, but every -break MUST be documented with migration guidance. Patch releases MUST remain -backward compatible. At and after `v1`, incompatible exported API or documented -behavior changes require a new major version. +This repository publishes one independently releasable root Go module. It uses +semantic versioning and root tags of the form `v`. The stable v1 line +keeps patch and minor releases backward compatible; incompatible exported API +or documented behavior changes require a new major version. Compatibility includes exported Go APIs, error classification, serialization, protocol behavior, persistence schemas, environment variables, command output, diff --git a/SECURITY.md b/SECURITY.md index d065576..5888c2f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -3,7 +3,8 @@ Security fixes are provided for the latest released major version and the Go versions supported by that release. -Do not open a public issue for a suspected vulnerability. Use GitHub's private -security advisory flow for `faustbrian/go-router`. Include an impact summary, -affected versions, reproduction, and any suggested mitigation. You should -receive an acknowledgement within seven days. +Do not open a public issue for a suspected vulnerability. Use the repository's +private [GitHub security advisory](https://github.com/faustbrian/go-router/security/advisories/new) +to report it. Include an impact summary, affected versions, reproduction, and +any suggested mitigation. You should receive an acknowledgement within seven +days. diff --git a/SUPPORT.md b/SUPPORT.md index 90fa605..ed6a795 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,13 +1,17 @@ # Support -Use GitHub issues for reproducible defects, documentation gaps, and bounded -feature proposals. Include the module path and version, Go version, platform, -minimal reproduction, expected behavior, actual behavior, and relevant -non-secret logs. +Use [GitHub issues](https://github.com/faustbrian/go-router/issues/new) for +reproducible defects, documentation gaps, and bounded feature proposals. +Include the module path and version, Go version, platform, minimal +reproduction, expected behavior, actual behavior, and relevant non-secret +logs. -Use GitHub Discussions for adoption questions and design exploration. Use the -private process in [`SECURITY.md`](SECURITY.md) for vulnerabilities. +Use [GitHub Discussions](https://github.com/faustbrian/go-router/discussions) +for adoption questions and design exploration. Use the private process in +[`SECURITY.md`](SECURITY.md) for vulnerabilities. Support covers released module versions according to -[`COMPATIBILITY.md`](COMPATIBILITY.md). Unreleased main-branch behavior may -change while remediation gates are incomplete. +[`COMPATIBILITY.md`](COMPATIBILITY.md). The stable v1 line is supported; users +on an older v1 patch should reproduce against the latest published v1 release +before reporting a defect. The `main` branch is unreleased development, not a +supported deployment target.