Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP]: naming guidelines #8238

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

[WIP]: naming guidelines #8238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3108ee
draft: naming guidelines
BenTheElder Jan 8, 2025
98e5d0b
cross-link naming guidelines
BenTheElder Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions committee-steering/governance/project-naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# 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`, ...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: can you line wrap?


"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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We recommend *but do not require* Kubernetes SIGS consider leveraging these when naming new subprojects, to further identify as an official project.
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 confusing names that sound like an official Kubernetes subproject, IE "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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
We ask that third-party projects refrain from confusing names that sound like an official Kubernetes subproject, IE "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.
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)
2 changes: 2 additions & 0 deletions github-management/kubernetes-repositories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.)
Expand Down Expand Up @@ -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
Expand Down