Skip to content

Commit d9d1aa8

Browse files
worageeknoid
authored andcommitted
Update STYLE-GUIDE.md (#369)
Update guideline not to use acronyms in API definition. Fixed #364.
1 parent c68809c commit d9d1aa8

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

STYLE-GUIDE.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@ naming convention:
2323
are recommended to avoid mixture of plural and singular words in
2424
a package name. For example, `istio.network.config.v1`.
2525

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

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

4041
When defining Kubernetes Custom Resource Definition (CRD) using
41-
`proto3`, follow the following guidelines:
42+
`proto3`, follow these guidelines:
43+
4244
* The proto `package` name must match the Kubernetes `apiVersion`,
4345
excluding the `.io` DNS suffix and reversing the DNS segment
4446
ordering. The Kubernetes `apiVersion` has the format of
4547
`group/version`.
48+
4649
* The proto message type must match the CRD `kind` name.
4750

4851
#### Example

0 commit comments

Comments
 (0)