Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (67 loc) · 5.2 KB

CONTRIBUTING.md

File metadata and controls

95 lines (67 loc) · 5.2 KB

Contributing to the Calico Codebase

Thanks for considering contributing to Calico! This document outlines the canonical procedure for contributing new features and bugfixes to Calico. Following these steps will help ensure that your contribution gets merged quickly and efficiently.

Overview

Is this a new feature?

If you'd like to add a new feature to Calico, please first open an issue describing the desired functionality. A Calico maintainer will work with you to come up with the correct design for the new feature. Once you've agreed on a design, you can then start contributing code to the relevant Calico repositories using the development process described below.

Remember, agreeing on a design in advance will greatly increase the chance that your PR will be accepted, and minimize the amount of time required for both you and your reviewer!

Is this a simple bug fix?

Simple bug fixes can just be raised as a pull request. Make sure you describe the bug in the pull request description, and please try to reproduce the bug in a unit test. This will help ensure the bug stays fixed!

Writing, testing, and building the code

For more detailed information on the development process for Calico, see the developer guide.

PR process

Once you've agreed on a design for your bugfix or new feature, development against the Calico codebase should be done using the following steps:

  1. Create a personal fork of the repository.
  2. Pull the latest code from the master branch and create a feature branch off of this in your fork.
  3. Implement your feature. Commits are cheap in Git; try to split up your code into many. It makes reviewing easier as well as for saner merging.
  4. Make sure that existing tests are passing, and that you've written new tests for any new functionality. Each directory has its own suite of tests.
  5. Push your feature branch to your fork on GitHub.
  6. Create a pull request using GitHub, from your fork and branch to projectcalico master.
    1. If you haven't already done so, you will need to agree to our contributor agreement. See below.
    2. Opening a pull request will automatically run your changes through our CI. Make sure all pre-submit tests pass so that a maintainer can merge your contribution.
  7. Await review from a maintainer.
  8. When you receive feedback:
    1. Address code review issues on your feature branch.
    2. Push the changes to your fork's feature branch on GitHub in a new commit - do not squash! This automatically updates the pull request.
    3. If necessary, make a top-level comment along the lines of “Please re-review”, notifying your reviewer, and repeat the above.
    4. Once all the requested changes have been made, your reviewer may ask you to squash your commits. If so, combine the commits into one with a single descriptive message.
    5. Once your PR has been approved and the commits have been squashed, your reviewer will merge the PR. If you have the necessary permissions, you may merge the PR yourself.

Patching an older release

If your contribution is intended for an older release, the change will need to be cherry-picked into the appropriate release branch after it has been reviewed and merged into master.

To create the cherry-pick PR, use hack/cherry-pick-pull:

<ENV_SETTINGS> ./hack/cherry-pick-pull origin/release-vX.YY <PR_NUMBER>

where release-vX.YY is the branch you are picking to. In <ENV_SETTINGS> you may need (if you don't already have them in your environment):

  • CHERRY_PICK=1, to tell the script to use git cherry-pick instead of a sequence of individual commit patches
  • GITHUB_TOKEN=<your GitHub token>
  • GITHUB_USER=<your GitHub user name>
  • FORK_REMOTE=<the remote name for the fork in which to create the PR branch>.

Then:

  • Make sure the pull request is in the correct GitHub milestone for the next vX.Y.Z release.
  • Get the pick PR approved, likely by asking the reviewer of the original PR, and merged.

Release notes and documentation

Most PRs warrant release notes - any bug fixes or new features that users may be interested in. If you are unsure if your PR warrants a release note in the description, ask your reviewer.

You or your reviewer should make sure that your PR has the correct labels and milestone set.

Every PR needs one docs-* label.

  • docs-pr-required: This change requires a change to the documentation that has not been completed yet.
  • docs-completed: This change has all necessary documentation completed.
  • docs-not-required: This change has no user-facing impact and requires no docs.

Every PR needs one release-note-* label.

  • release-note-required: This PR has user-facing changes. Most PRs should have this label.
  • release-note-not-required: This PR has no user-facing changes.

Other optional labels:

  • needs-operator-pr: This PR is related to install and requires a corresponding change to the operator.

Contributor Agreements

We need you to sign our Contributor License Agreement before we can accept your contribution. You will be prompted to do this as part of the PR process on GitHub.