Skip to content

Update STYLE-GUIDE.md #369

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 1 commit into from
Feb 9, 2018
Merged

Update STYLE-GUIDE.md #369

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions STYLE-GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ naming convention:
are recommended to avoid mixture of plural and singular words in
a package name. For example, `istio.network.config.v1`.

* Message/enum/method names must use `CamelCase` with embedded
acronyms. For example, `HTTPRequest`.
* Message/enum/method names must use `CamelCase` without any embedded
acronyms, see [#364](https://github.com/istio/api/issues/364) for
reasons. For example, `HttpRequest`.

* Enum values must use `UPPERCASE_WITH_UNDERSCORE`. For example,
`INT_TYPE`.
Expand All @@ -38,11 +39,13 @@ naming convention:
## Versioning

When defining Kubernetes Custom Resource Definition (CRD) using
`proto3`, follow the following guidelines:
`proto3`, 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
Expand Down