You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,7 @@ You can contribute by:
18
18
19
19
All bugs, tasks or enhancements are tracked as GitHub issues.
20
20
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)
21
22
22
23
## DCO Signoff
23
24
@@ -35,6 +36,23 @@ The GitHub teams `@kroxylicious/code-reviewers` and `@kroxylicious/doc-reviewers
35
36
36
37
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.
37
38
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
+
38
56
## I just have a question
39
57
40
58
If you encounter any issues while using Kroxylicious, you can get help using:
0 commit comments