Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down
11 changes: 4 additions & 7 deletions COMPATIBILITY.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
# Compatibility Policy

Each releasable directory is an independent Go module and follows semantic
versioning. Tags use `<module-directory>/v<version>`.

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<version>`. 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,
Expand Down
9 changes: 5 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
20 changes: 12 additions & 8 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -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.
Loading