Skip to content

Commit 6191aff

Browse files
committed
README: Link to specs-go and schema and declare Go-compat policy
The links help with discoverability, otherwise folks reading the README might not notice that we provided these resources in addition to the spec itself. By declaring a Go-compat policy, folks who have Go troubles can tell without testing whether the image-spec tooling *should* work for their Go environment. And if/when it does not, they can see whether image-spec is interested in patches or not. For example, if the tooling breaks on Go 1.6, we don't care or want some awkward workaround. But if it breaks on Go 1.7 we do care and want a patch. The Go-compat policy formalizes [1]. Previous maintainer comments suggested some support for older Go releases [2], and I personally think we want to give people more flexibility (not everyone can upgrade to a new Go version on the day it comes out), but this commit at least documents where we are now as a base for future discussion. [1]: opencontainers#500 (comment) [2]: opencontainers#487 (comment) Signed-off-by: W. Trevor King <[email protected]>
1 parent 409e1a5 commit 6191aff

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ The OCI Image Format project creates and maintains the software shipping contain
99

1010
The specification can be found [here](spec.md).
1111

12+
This repository also provides [Go types](specs-go), [intra-blob validation tooling, and JSON Schema](schema).
13+
The Go types and validation should be compatible with the current Go release; earlier Go releases are not supported.
14+
1215
Additional documentation about how this group operates:
1316

1417
- [Code of Conduct](https://github.com/opencontainers/tob/blob/d2f9d68c1332870e40693fe077d311e0742bc73d/code-of-conduct.md)

0 commit comments

Comments
 (0)