-
Notifications
You must be signed in to change notification settings - Fork 528
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add pkg/registry/README.md documenting expectations (#1167)
- Loading branch information
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# `pkg/registry` | ||
|
||
This package implements a Docker v2 registry and the OCI distribution specification. | ||
|
||
It is designed to be used anywhere a low dependency container registry is needed, with an initial focus on tests. | ||
|
||
Its goal is to be standards compliant and its strictness will increase over time. | ||
|
||
This is currently a low flightmiles system. It's likely quite safe to use in tests; If you're using it in production, please let us know how and send us PRs for integration tests. | ||
|
||
Before sending a PR, understand that the expectation of this package is that it remain free of extraneous dependencies. | ||
This means that we expect `pkg/registry` to only have dependencies on Go's standard library, and other packages in `go-containerregistry`. | ||
|
||
You may be asked to change your code to reduce dependencies, and your PR might be rejected if this is deemed impossible. |