Skip to content

Commit 0f6ba50

Browse files
authored
Merge pull request #8238 from BenTheElder/WIP-naming
naming guidelines
2 parents dcbc241 + 1200480 commit 0f6ba50

File tree

2 files changed

+22
-0
lines changed

2 files changed

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

github-management/kubernetes-repositories.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ from a central body (e.g. steering committee or sig-architecture)
6868
### Rules for new repositories
6969

7070
* For now all repos will live in `github.com/kubernetes-sigs/\<project-name\>`.
71+
* For project names: see [project-naming](./../committee-steering/governance/project-naming.md)
7172
* Must contain the topic for the sponsoring SIG - e.g.
7273
`k8s-sig-api-machinery`. (Added through the *Manage topics* link on the
7374
repo page.)
@@ -108,6 +109,7 @@ the developers who could not be reached
108109
ideally occur shortly thereafter.
109110
* Should contain template files as per the
110111
[kubernetes-template-project](https://github.com/kubernetes/kubernetes-template-project).
112+
* For project names: see [project-naming](./../committee-steering/governance/project-naming.md)
111113

112114
Note that copyright notices should only be modified or removed by the people or
113115
organizations named in the notice. See [the FAQ below](#faq) for more information

0 commit comments

Comments
 (0)