Merge pull request #8238 from BenTheElder/WIP-naming

naming guidelines
This commit is contained in:
Kubernetes Prow Robot 2025-02-05 08:34:17 -08:00 committed by GitHub
commit 0f6ba50407
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 0 deletions

View File

@ -0,0 +1,20 @@
# Project Naming
The Kubernetes project has historically named most of our components/projects
with a "kube" substring like `kube-proxy`, `kubectl`, `kube-apiserver`,
`kube-controller-manager`, `kube-scheduler`, `minikube`, ...
"Kubernetes" and "K8s" are registered [trademarks under the Linux Foundation](https://www.linuxfoundation.org/legal/trademarks).
We recommend *but do not require* Kubernetes SIGs consider leveraging these when
naming new subprojects, to further identify as an official project.
We ask that third-party projects refrain from using confusing names that sound
like an official Kubernetes subproject, i.e. "kube", "k8s", "kubernetes"
substrings and pick some alternate creative name, with a notable exception for
[Conformant Distros](https://www.cncf.io/training/certification/software-conformance/).
Many existing projects have not done this, and we are not seeking to alter them, but
do remember that "k8s" and "kubernetes" are protected trademarks.
If you'd like to start a new sub-project within the Kubernetes project, see our
[repository donation / creation guidelines](https://git.k8s.io/community/github-management/kubernetes-repositories.md).

View File

@ -68,6 +68,7 @@ from a central body (e.g. steering committee or sig-architecture)
### Rules for new repositories
* For now all repos will live in `github.com/kubernetes-sigs/\<project-name\>`.
* For project names: see [project-naming](./../committee-steering/governance/project-naming.md)
* Must contain the topic for the sponsoring SIG - e.g.
`k8s-sig-api-machinery`. (Added through the *Manage topics* link on the
repo page.)
@ -108,6 +109,7 @@ the developers who could not be reached
ideally occur shortly thereafter.
* Should contain template files as per the
[kubernetes-template-project](https://github.com/kubernetes/kubernetes-template-project).
* For project names: see [project-naming](./../committee-steering/governance/project-naming.md)
Note that copyright notices should only be modified or removed by the people or
organizations named in the notice. See [the FAQ below](#faq) for more information