First - thank you for taking the time to look up how to contribute to KubeDirector! We know your time is valuable, and we want to make sure that you're able to work easily and effectively with the code that we're providing.
Most of the developers working on KubeDirector use MacOS, so there may be some unforseen issues in Linux and Windows development. Please make a Pull Request against this file if something here is out of date or inaccurate. Currently, we use the following tools and versions:
- go version 1.12
- dep version 0.5.2
Many people have also set up travis-ci on their personal forks. To set up travis-ci on your personal fork, follow these instructions:
- Log in to GitHub
- Sign up for Travis CI (link)
- In Github, go to the GitHub Marketplace
- Click "Continuous Integration" in the left "Categories" tree.
- Click "Travis CI"
- Scroll to the bottom, Highlight "Open Source", and click "Install it for free"
- Click "Complete Order"
- Under "Install on your personal account", select "Only select repositories"
- From the dropdown below the radio button, select kubedirector
- Click Install
Before making a Pull Request, please ensure that the code still builds. If you're on Windows, this might not work, but if you're on MacOS or Linux, this process should be pretty seamless.
Attempt a build with the following steps:
make depmake compilemake build
If everything works in that sequence, please push to your fork and make the Pull Request. We will do our best to get to your Pull Request in a timely fashion. It may take a while to get to any given Pull Request - please be patient. Please note that having a travis-ci build set up on a personal fork will allow you to run checks before opening your Pull Request.