Skip to content

Commit 6e1e740

Browse files
committed
Document Go compatibility matrix and support policy
1 parent 10f34ea commit 6e1e740

4 files changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ Long-form guides live in `docs/`:
163163
- `docs/typing.md` – gradual typing: annotations, nullable `?`, positional/keyword binding, and return checks.
164164
- `docs/examples/` – runnable scenario guides (campaign reporting, rewards, notifications, module usage, and more).
165165
- `docs/releasing.md` – GoReleaser workflow for changelog and GitHub release automation.
166+
- `docs/compatibility.md` – supported Go versions and CI coverage notes.
166167
- `ROADMAP.md` – versioned implementation checklist and release roadmap.
167168

168169
## Development

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ Goal: improve day-to-day developer productivity and interpreter robustness.
335335

336336
- [ ] Add smoke tests for docs examples to CI.
337337
- [ ] Add release checklist automation for changelog/version bumps.
338-
- [ ] Add compatibility matrix notes for supported Go versions.
338+
- [x] Add compatibility matrix notes for supported Go versions.
339339

340340
### v0.19.0 Definition of Done
341341

docs/compatibility.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Go Compatibility Matrix
2+
3+
VibeScript currently targets the Go toolchain version declared in `go.mod`.
4+
5+
| Go Version | Status | CI Coverage | Notes |
6+
| --- | --- | --- | --- |
7+
| `1.26.x` | Supported | `ubuntu-latest`, `macos-latest`, `windows-latest` | Primary development and release target. |
8+
| `<1.26` | Unsupported | None | May fail to build or run correctly. |
9+
| `>1.26` | Best effort | None | Expected to work, but not yet part of the pinned CI matrix. |
10+
11+
## Policy Notes
12+
13+
- The minimum supported Go version is the `go` directive in `go.mod`.
14+
- Before `v1.0`, minimum-version bumps may happen in minor releases.
15+
- Compatibility changes are tracked in `ROADMAP.md` and release notes.

docs/introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,4 @@ dives on specific topics.
3232
helpers with `require` and module search paths.
3333
- `stdlib_core_utilities.md` – examples for JSON, regex, random IDs, numeric
3434
conversion, and common time parsing helpers.
35+
- `compatibility.md` – supported Go versions and CI coverage expectations.

0 commit comments

Comments
 (0)