diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2567c00..ab21946 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,26 +1,11 @@ -# Contributing to the registry +# Contributing to the reference library -## Before reporting an issue... +## Community help -### If your problem is with... - - - automated builds or your [Docker Hub](https://hub.docker.com/) account - - Report it to [Hub Support](https://hub.docker.com/support/) - - Distributions of Docker for desktop or Linux - - Report [Mac Desktop issues](https://github.com/docker/for-mac) - - Report [Windows Desktop issues](https://github.com/docker/for-win) - - Report [Linux issues](https://github.com/docker/for-linux) - -### If you... - - - need help setting up your registry - - can't figure out something - - are not sure what's going on or what your problem is - -Please ask first in the [#distribution](https://cloud-native.slack.com/archives/C01GVR8SY4R) channel on CNCF community slack. +If you need help, please ask in the [#distribution](https://cloud-native.slack.com/archives/C01GVR8SY4R) channel on CNCF community slack. [Click here for an invite to the CNCF community slack](https://slack.cncf.io/) -### Reporting security issues +## Reporting security issues The maintainers take security seriously. If you discover a security issue, please bring it to their attention right away! diff --git a/GOVERNANCE.md b/GOVERNANCE.md index bd40c44..200045b 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1,4 +1,4 @@ -# distribution/distribution Project Governance +# distribution/reference Project Governance Distribution [Code of Conduct](./CODE-OF-CONDUCT.md) can be found here. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fead4f8 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Distribution reference + +Go library to handle references to container images. + + + +[![Build Status](https://github.com/distribution/reference/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/distribution/reference/actions?query=workflow%3ACI) +[![GoDoc](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/distribution/reference) +[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE) +[![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fdistribution%2Freference.svg?type=shield)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fdistribution%2Freference?ref=badge_shield) + +This repository contains a library for handling refrences to container images held in container registries. Please see [godoc](https://pkg.go.dev/github.com/distribution/reference) for details. + +## Contribution + +Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute +issues, fixes, and patches to this project. + +## Communication + +For async communication and long running discussions please use issues and pull requests on the github repo. +This will be the best place to discuss design and implementation. + +For sync communication we have a #distribution channel in the [CNCF Slack](https://slack.cncf.io/) +that everyone is welcome to join and chat about development. + +## Licenses + +The distribution codebase is released under the [Apache 2.0 license](LICENSE). diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..aaf983c --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Security Policy + +## Reporting a Vulnerability + +The maintainers take security seriously. If you discover a security issue, please bring it to their attention right away! + +Please DO NOT file a public issue, instead send your report privately to cncf-distribution-security@lists.cncf.io.