Skip to content

Commit ec2d412

Browse files
committed
Add design process
Signed-off-by: Robert Young <robertyoungnz@gmail.com>
1 parent 43151d1 commit ec2d412

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ You can contribute by:
1818

1919
All bugs, tasks or enhancements are tracked as GitHub issues.
2020
Issues which might be a good start for new contributors are marked with the “good-start” label.
21+
Public API changes are required to follow the [Design Process](#design-process)
2122

2223
## DCO Signoff
2324

@@ -35,6 +36,23 @@ The GitHub teams `@kroxylicious/code-reviewers` and `@kroxylicious/doc-reviewers
3536

3637
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.
3738

39+
## Design Process
40+
41+
All Public API changes must begin with a design proposal. This includes:
42+
43+
* New APIs or API endpoints
44+
* Changes to existing API signatures or behavior
45+
* Removal or deprecation of APIs
46+
47+
Public APIs include (but are not limited to):
48+
* Proxy configuration YAML
49+
* Built-in Filter configuration YAML
50+
* Kubernetes CRDs
51+
* Operator manifested resources (like public bootstrap server addresses)
52+
* Filter API
53+
54+
Design proposals should be submitted to the [design repository](https://github.com/kroxylicious/design).
55+
3856
## I just have a question
3957

4058
If you encounter any issues while using Kroxylicious, you can get help using:

0 commit comments

Comments
 (0)