Skip to content

Commit

Permalink
Update template files to include repo-specific info
Browse files Browse the repository at this point in the history
  • Loading branch information
nikhita committed Mar 29, 2020
1 parent 4a0089c commit 8f2248c
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 45 deletions.
9 changes: 2 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!

<!---
Custom Information - if you're copying this template for the first time you can add custom content here, for example:
## Contact Information

- [Slack channel](https://kubernetes.slack.com/messages/kubernetes-users) - Replace `kubernetes-users` with your slack channel string, this will send users directly to your channel.
- [Mailing list](URL)
-->
- [Slack](https://kubernetes.slack.com/messages/kubebuilder)
- [Mailing List](https://groups.google.com/forum/#!forum/kubebuilder)
11 changes: 7 additions & 4 deletions OWNERS
Original file line number Diff line number Diff line change
@@ -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
36 changes: 23 additions & 13 deletions OWNERS_ALIASES
Original file line number Diff line number Diff line change
@@ -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
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,16 @@
# 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

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)
- [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
8 changes: 4 additions & 4 deletions SECURITY_CONTACTS
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 8f2248c

Please sign in to comment.