Skip to content

Commit

Permalink
README: Link to specs-go and schema and declare Go-compat policy
Browse files Browse the repository at this point in the history
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]: #500 (comment)
[2]: #487 (comment)

Signed-off-by: W. Trevor King <[email protected]>
  • Loading branch information
wking committed Dec 16, 2016
1 parent 409e1a5 commit 6191aff
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ The OCI Image Format project creates and maintains the software shipping contain

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

This repository also provides [Go types](specs-go), [intra-blob validation tooling, and JSON Schema](schema).
The Go types and validation should be compatible with the current Go release; earlier Go releases are not supported.

Additional documentation about how this group operates:

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

0 comments on commit 6191aff

Please sign in to comment.