From 8f2248c7cdfca98ece5b955bfe3238ab2ec55cde Mon Sep 17 00:00:00 2001 From: Nikhita Raghunath Date: Sun, 29 Mar 2020 18:53:24 +0530 Subject: [PATCH] Update template files to include repo-specific info --- CONTRIBUTING.md | 9 ++------- OWNERS | 11 +++++++---- OWNERS_ALIASES | 36 +++++++++++++++++++++++------------- README.md | 21 ++++----------------- SECURITY_CONTACTS | 8 ++++---- 5 files changed, 40 insertions(+), 45 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cbbabb5292e..fc02b7769a69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,7 @@ If your repo has certain guidelines for contribution, put them here ahead of the - [Mentoring Initiatives](https://git.k8s.io/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers! - +- [Slack](https://kubernetes.slack.com/messages/kubebuilder) +- [Mailing List](https://groups.google.com/forum/#!forum/kubebuilder) diff --git a/OWNERS b/OWNERS index f3508c950eb5..a973498d7ba1 100644 --- a/OWNERS +++ b/OWNERS @@ -1,6 +1,9 @@ -# See the OWNERS docs at https://go.k8s.io/owners +# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md approvers: - # TODO: in your repo created from this template, you should replace the - # steering-committee with a list of project owners, see the doc linked above. - - steering-committee + - kubebuilder-admins + - kubebuilder-approvers +reviewers: + - kubebuilder-admins + - kubebuilder-reviewers + - kubebuilder-approvers diff --git a/OWNERS_ALIASES b/OWNERS_ALIASES index f039e1ced2ae..4d2e7e86190e 100644 --- a/OWNERS_ALIASES +++ b/OWNERS_ALIASES @@ -1,15 +1,25 @@ -# See the OWNERS docs at https://go.k8s.io/owners#owners_aliases +# See the OWNERS docs: https://git.k8s.io/community/contributors/guide/owners.md aliases: - # TODO: remove this alias, it will go stale in your repo, and in your repo - # you should have your own set of approvers (see OWNERS) - # in the original template repo, we must maintain this list to approve changes - # to the template itself - steering-committee: - - cblecker - - derekwaynecarr - - dims - - nikhita - - parispittman - - spiffxp - - timothysc + # active folks who can be contacted to perform admin-related + # tasks on the repo, or otherwise approve any PRs. + kubebuilder-admins: + - droot + - mengqiy + - directxman12 + + # non-admin folks who can approve any PRs in the repo + kubebuilder-approvers: + - camilamacedo86 + + # folks who can review and LGTM any PRs in the repo (doesn't include + # approvers & admins -- those count too via the OWNERS file) + kubebuilder-reviewers: + - joelanford + - estroz + - adirio + + # folks who may have context on ancient history, + # but are no longer directly involved + kubebuilder-emeritus-approvers: + - pwittrock diff --git a/README.md b/README.md index ba5444fdd8a4..cd59d95137ae 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,6 @@ -# Kubernetes Template Project +# Kubebuilder Release Tools -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://git.k8s.io/security/private-distributors-list.md#embargo-policy) - and will be removed and replaced if they violate that agreement. +Release tooling for KubeBuilder projects. ## Community, discussion, contribution, and support @@ -18,12 +8,9 @@ Learn how to engage with the Kubernetes community on the [community page](http:/ You can reach the maintainers of this project at: -- [Slack](http://slack.k8s.io/) -- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-dev) +- [Slack](https://kubernetes.slack.com/messages/kubebuilder) +- [Mailing List](https://groups.google.com/forum/#!forum/kubebuilder) ### 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 diff --git a/SECURITY_CONTACTS b/SECURITY_CONTACTS index 4dfb303bfa08..cc49f4ee79b6 100644 --- a/SECURITY_CONTACTS +++ b/SECURITY_CONTACTS @@ -1,14 +1,14 @@ # Defined below are the security contacts for this repo. # -# They are the contact point for the Product Security Committee to reach out +# They are the contact point for the Product Security Team to reach out # to for triaging and handling of incoming issues. # # The below names agree to abide by the -# [Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy) +# [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. # # DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE # INSTRUCTIONS AT https://kubernetes.io/security/ -bob -alice +droot +pwittrock