CONTRIBUTING.md

Contributing

We welcome contributions of all kinds including code, issues or documentation.

 Contributing Code

To contribute code, please follow this steps:

1. Communicate with us on the issue you want to work on
2. Make your changes
3. Test your changes
4. Update the documentation if needed and examples too
5. Ensure to run make reviewable test without issues
6. Open a pull request

Ensure to use a good commit hygiene and follow the conventional commits specification.

 Development environment

Get git submodules:

make submodules

Run code-generation pipeline:

make generate

Run against a Kubernetes cluster:

make run

Build binary:

make build

Testing environment

For testing purpose you may need a Kubernetes environment, you can deal with microK8s, k3d, k3s, kind or what you prefer.

1. Apply CRDs manifests to your cluster : kubectl apply -f package/crds
2. Create ProviderConfig : with the templates in examples/providerconfig you need to create a secret and a providerconfig and apply them to your cluster
3. Run the provider locally : make run

Now you can to test your resources. Typically, you need to copy examples-generatedresource in examples, modify it and test it.