Initial commit from kubernetes-template-project
This commit is contained in:
29
README.md
Normal file
29
README.md
Normal file
@@ -0,0 +1,29 @@
|
||||
# Kubernetes Template Project
|
||||
|
||||
The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files:
|
||||
|
||||
- a `README.md` outlining the project goals, sponsoring sig, and community contact information
|
||||
- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners])
|
||||
- a `CONTRIBUTING.md` outlining how to contribute to the project
|
||||
- an unmodified copy of `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code
|
||||
- a `LICENSE` which must be Apache 2.0 for code projects, or [Creative Commons 4.0] for documentation repositories, without any custom content
|
||||
- a `SECURITY_CONTACTS` with the contact points for the Product Security Team
|
||||
to reach out to for triaging and handling of incoming issues. They must agree to abide by the
|
||||
[Embargo Policy](https://github.com/kubernetes/sig-release/blob/master/security-release-process-documentation/security-release-process.md#embargo-policy)
|
||||
and will be removed and replaced if they violate that agreement.
|
||||
|
||||
## Community, discussion, contribution, and support
|
||||
|
||||
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
|
||||
|
||||
You can reach the maintainers of this project at:
|
||||
|
||||
- [Slack](http://slack.k8s.io/)
|
||||
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-dev)
|
||||
|
||||
### Code of conduct
|
||||
|
||||
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
|
||||
|
||||
[owners]: https://git.k8s.io/community/contributors/guide/owners.md
|
||||
[Creative Commons 4.0]: https://git.k8s.io/website/LICENSE
|
Reference in New Issue
Block a user