Getting Started 🔗︎
Welcome! This guide covers how to get started contributing to kind.
1. Read the Kubernetes community guidelines 🔗︎
Additionally, note that kind is developed on GitHub and will require an account to contribute.
2. Install Tools 🔗︎
Install git 🔗︎
Our source code is managed with
git, to develop locally you
will need to install
You can check if
git is already on your system and properly installed with
the following command:
Install Hugo 🔗︎
If you wish to contribute to the documentation, it is recommended but not required to install hugo, which we use to develop this site.
Please see: https://gohugo.io/getting-started/installing/
Install Go 🔗︎
To work on kind’s codebase you will need Go.
Install or upgrade Go using the instructions for your operating system. You can check if Go is in your system with the following command:
1.12.5 or greater should be installed.
Correct automatic formatting of the source with
gofmt requires at least
Working with Go modules requires at
1.11.4 due to checksum bugs in lower versions.
Install Docker 🔗︎
Currently, to create clusters you will need to install Docker.
To check if
docker is has been installed:
This documentation is written using Docker version 18.09.2.
3. Read The Docs 🔗︎
4. Reaching Out 🔗︎
Issues are tracked on GitHub. Please check the issue tracker to see if there is any existing discussion or work related to your interests.
If you do not see anything, please file a new issue.
Please reach out for bugs, feature requests, and other issues!
The maintainers of this project are reachable via:
See also: the Kubernetes community page.