Thanks for thinking about contributing to Project Calico! The success of an open source project is entirely down to the efforts of its contributors, so we do genuinely want to thank you for even thinking of contributing.
This document contains some guidance and steps for contributing. Make sure you read it thoroughly, because if you miss some of these steps we will have to ask you to do them after you make your submission, and that slows down our ability to merge it.
If you plan to contribute in the form of documentation or code, before we can accept your contribution we need you to sign our Contributor License Agreement. You will be prompted to do this as part of the PR process on Github.
For contributing code and documentation we follow the GitHub pull request model. This means you should fork our repository on GitHub, make your changes in your local repository, and then open a GitHub pull request. This pull request will then go through a review process by one or more of the core team.
Code changes will additionally be tested by our continuous integration server. We will not accept changes that do not consistently pass our automated unit test suite. It is vital that our master branch be passing tests at all times: hence the restriction.
The relevant tests are our unit tests: you can run them yourself by running
make ut from the root of the repository.
Assuming your code review is finished and tests are passing, your change will
then be merged as soon as possible! Occasionally we will sit on a change, for
instance if we are planning to tag a release shortly, but this is only to
ensure the stability of the branch. After the release we will merge your change
promptly.