kubernetes-template-project's Introduction

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)
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 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.

You can reach the maintainers of this project at:

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

kubernetes-template-project's Issues

Document DCO signed-off-by requirement?

The CNCF charter has (§11.c):

All new inbound code contributions to the CNCF shall be (i) accompanied by a Developer Certificate of Origin sign-off (http://developercertificate.org) and (ii) made under the Apache License, Version 2.0 (available at http://www.apache.org/licenses/LICENSE-2.0), such license to be in addition to, and shall not supersede, obligations undertaken under the contribution license agreement(s) provided for in (b) above.

But the CONTRIBUTING.md file in this repository currently only mentions the CLA ~~(which is optional per-project, as discussed in §11.b)~~. It should probably be expanded to include the DCO and Signed-off-by docs (I have a project for including stock docs, or you can write your own) to comply with §11.c, ~~and may deserve a note (in the docs requested in #2?) to point out that project owners can remove the CLA requirement if they want~~ [EDIT: CLAs are not optional for Kubernetes projects].

Please update the LICENSE with the copyright holder

It should be "The Kubernetes Authors".

Most repos haven't modified the boilerplate Copyright {yyyy} {name of copyright owner}

Document recommended repo setup

Forked from kubernetes/kops#644

I think it would be useful to describe the recommended setup for repos in the template.

For example, admin and maintainers (write) teams.

And how to turn on the bot. And copy labels.

And OWNERS.

Etc

cc @grodrigues3

Recommend Projects

kubernetes / kubernetes-template-project Goto Github PK