Skip to content

KubeStellar has multiple documentation versions to match its multiple releases.
Please make sure you are viewing the docs version which matches the release version of the code you are using!

Contributing to KubeStellar

{% include "../../../CONTRIBUTING.md" start="" end="" %}

Please make sure that your environment has all the necessary versions as spelled out in the prerequisites section of our user guide

{% include "../../../CONTRIBUTING.md" start="" end="" %}

See Git Commit Signoff and Signing for more information on how to do that.

{% include "../../../CONTRIBUTING.md" start="" end="" %}

Our Getting Started guide shows a user how to install a simple "kick the tires" instance of KubeStellar using a helm chart and kind.

To set up and test a development system, please refer to the test/e2e/README.md file in the GitHub repository. After running any of those e2e (end to end) tests you will be left with a running system that can be exercised further.

{% include "../../../CONTRIBUTING.md" start="" end="" %}

If you are interested in modifying the Helm chart itself, look at the User Guide page on the Core Helm chart for more information on its many options before you begin, notably on how to specify using a local version of the script.

{% include "../../../CONTRIBUTING.md" start="" end="" %}

KubeStellar is Apache 2.0 licensed and we accept contributions via GitHub pull requests.

{% include "../../../CONTRIBUTING.md" start="" %}

Note: this file "contribute-github.md" is a wrapper that includes the CONTRIBUTING.md file found in the root of the KubeStellar repository, adding website relative links while eliding relative navigation links that are specific to the repository folder structure