From 5ef06be5c7353210281e982bda46519e96d5a4a7 Mon Sep 17 00:00:00 2001 From: Robert Young Date: Mon, 30 Mar 2026 17:02:31 +1300 Subject: [PATCH 1/3] Add design process Signed-off-by: Robert Young --- CONTRIBUTING.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a007ad7..874fa38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,7 @@ You can contribute by: All bugs, tasks or enhancements are tracked as GitHub issues. Issues which might be a good start for new contributors are marked with the “good-start” label. +Public API changes are required to follow the [Design Process](#design-process) ## DCO Signoff @@ -35,6 +36,24 @@ The GitHub teams `@kroxylicious/code-reviewers` and `@kroxylicious/doc-reviewers If you're willing to provide code and/or reviews to others then let one of the [project managers](PMs.md) know and we can add you to the relevant GitHub team. +## Design Process + +All Public API changes must begin with a design proposal. This includes: + +* New APIs or API endpoints +* Changes to existing API signatures or behavior +* Removal or deprecation of APIs + +Public APIs include (but are not limited to): +* Proxy configuration YAML +* Filter configuration YAML +* Kubernetes CRDs +* Operator manifested resources (like public bootstrap server addresses) +* Filter API (and other plugins) interfaces +* Wire-protocol changes (e.g. format of encrypted data emitted by Proxy) + +Design proposals should be submitted to the [design repository](https://github.com/kroxylicious/design). + ## I just have a question If you encounter any issues while using Kroxylicious, you can get help using: From 263f40cb2c56835a2c6d06dbcd5db731301b1404 Mon Sep 17 00:00:00 2001 From: Robert Young Date: Tue, 14 Apr 2026 12:29:41 +1200 Subject: [PATCH 2/3] Add instruction to advertise proposal on mailing list Signed-off-by: Robert Young --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 874fa38..8175c95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,7 @@ Public APIs include (but are not limited to): * Wire-protocol changes (e.g. format of encrypted data emitted by Proxy) Design proposals should be submitted to the [design repository](https://github.com/kroxylicious/design). +After creating a design proposal, please advertise it on the kroxylicious-dev@googlegroups.com [mailing list](https://kroxylicious.io/join-us/mailing-lists). ## I just have a question From 0d29aab23a9fa7304fccaf11a40a895d8693eb21 Mon Sep 17 00:00:00 2001 From: Robert Young Date: Tue, 14 Apr 2026 12:30:56 +1200 Subject: [PATCH 3/3] Updated to say mail when ready-for-review Signed-off-by: Robert Young --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8175c95..4487790 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ Public APIs include (but are not limited to): * Wire-protocol changes (e.g. format of encrypted data emitted by Proxy) Design proposals should be submitted to the [design repository](https://github.com/kroxylicious/design). -After creating a design proposal, please advertise it on the kroxylicious-dev@googlegroups.com [mailing list](https://kroxylicious.io/join-us/mailing-lists). +After creating a design proposal, once it is ready for review, please advertise it on the kroxylicious-dev@googlegroups.com [mailing list](https://kroxylicious.io/join-us/mailing-lists). ## I just have a question