From 627b03bb00a7304820b92cc1b633f8b010e0052e Mon Sep 17 00:00:00 2001 From: Kuat Date: Wed, 21 Mar 2018 12:15:10 -0700 Subject: [PATCH] style: add note about alpha protos (#576) Signed-off-by: Kuat Yessenov --- STYLE.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/STYLE.md b/STYLE.md index 7c96fefe..d932c3a3 100644 --- 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).