Skip to content

Commit f3b04be

Browse files
authored
Update STYLE-GUIDE.md
Mention `apiVersion` must match proto package.
1 parent 2eacb18 commit f3b04be

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

STYLE-GUIDE.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,13 @@ naming convention:
3838
## Versioning
3939

4040
When defining Kubernetes Custom Resource Definition (CRD) using
41-
proto3, the proto versioning must match the Kubernetes versioning,
42-
and the proto message type must match the CRD kind name.
43-
see the following example.
41+
`proto3`, follow the following guidelines:
42+
* The proto `package` name must match the Kubernetes `apiVersion`,
43+
excluding the `.io` DNS suffix and reversing the DNS segment
44+
ordering.
45+
* The proto message type must match the CRD `kind` name.
46+
47+
#### Example
4448

4549
The Kubernetes CRD:
4650

0 commit comments

Comments
 (0)