Skip to content

Update STYLE-GUIDE.md #343

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

Merged
merged 3 commits into from
Feb 9, 2018
Merged

Update STYLE-GUIDE.md #343

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2eacb18
Update STYLE-GUIDE.md
wora Feb 1, 2018
f3b04be
Update STYLE-GUIDE.md
wora Feb 1, 2018
cb0193b
Update STYLE-GUIDE.md
wora Feb 2, 2018
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
10 changes: 8 additions & 2 deletions STYLE-GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,14 @@ naming convention:
## Versioning

When defining Kubernetes Custom Resource Definition (CRD) using
proto3, the proto versioning should match the Kubernetes versioning,
see the following example.
`proto3`, follow the following guidelines:
Copy link
Contributor

Choose a reason for hiding this comment

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

, follow these guidelines:

* The proto `package` name must match the Kubernetes `apiVersion`,
excluding the `.io` DNS suffix and reversing the DNS segment
ordering. The Kubernetes `apiVersion` has the format of
`group/version`.
* The proto message type must match the CRD `kind` name.

#### Example

The Kubernetes CRD:

Expand Down