style: add note about alpha protos (#576)

Signed-off-by: Kuat Yessenov <kuat@google.com>
7 years ago · 627b03bb00
parent 11c750628b
commit 627b03bb00
1 changed files with 6 additions and 0 deletions
--- a/STYLE.md
+++ b/STYLE.md
@ -45,6 +45,12 @@ In addition, the following conventions should be followed:
 * Non-frozen fields should be tagged with `[#not-implemented-hide:]`, `[#not-implemented-warn:]`,
  `[#proto-status: draft]` or `[#proto-status: experimental]`.

+* Protos for configs and services that are not implemented immediately in
+  Envoy, or are under active design and development should be versioned
+  "v2alpha". If several iterations of the alpha API are expected, then versions
+  "v2alpha1", "v2alpha2", and so on are preferred. Alpha-versioned protos are
+  considered experimental and are not required to preserve compatibility.
+
 * Every proto directory should have a `README.md` describing its content. See
  for example [envoy.service](envoy/service/README.md).