Skip to content

Commit 1b01cec

Browse files
authored
chore: how to implement a new crd version (#227)
* chore: how to implement a new crd version Signed-off-by: Skye Gill <[email protected]> * Add CONTRIBUTING.md with development section for FeatureFlagConfiguration crd versioning Signed-off-by: Skye Gill <[email protected]> Signed-off-by: Skye Gill <[email protected]>
1 parent 0956a00 commit 1b01cec

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Guidelines
2+
3+
Welcome!
4+
5+
There are a few things to consider before contributing to open-feature-operator.
6+
7+
Firstly, there's [a code of conduct](https://github.com/open-feature/.github/blob/main/CODE_OF_CONDUCT.md).
8+
TLDR: be respectful.
9+
10+
Any contributions are expected to include tests. These can be validated with `make test` or the automated github workflow will run them on PR creation.
11+
12+
The go version in the `go.mod` is the currently supported version of go.
13+
14+
Thanks! Issues and pull requests following these guidelines are welcome.
15+
16+
## Development
17+
18+
### FeatureFlagConfiguration custom resource definition versioning
19+
Custom resource definitions support multiple versions. The kubebuilder framework exposes a system to seamlessly convert between versions (using a "hub and spoke" model) maintaining backwards compatibility. It does this by injecting conversion webhooks that call our defined convert functions. The hub version of the `FeatureFlagConfiguration` custom resource definition (the version to which all other versions are converted) is `v1alpha1`.
20+
Follow [this tutorial](https://book.kubebuilder.io/multiversion-tutorial/conversion-concepts.html) to implement a new version of the custom resource definition.

0 commit comments

Comments
 (0)