Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 2.6 KB

CONTRIB.md

File metadata and controls

72 lines (47 loc) · 2.6 KB
Raw

Environment Setup

To build and test these images you will need to install bazel.

To install a pre-commit hook that will automatically run tests, run the following command:

cd .git/hooks/
ln -s ../../hacks/hooks/* .

Some of these images also rely on features only in a modern version of the tar command. Notably, OSX defaults to an older version of these coreutils.

To install the newer versions on OSX, follow these steps:

brew install coreutils
brew install gnu-tar --with-default-names

How to build these base images

We use bazel to build most of the images in this repository, so that we can build them reproducibly. To learn about how we generate reproducible images, see the design doc.

To build all images, use:

bazel build //...

This can be slow the first time, but future builds are incremental and very fast.

Tests are implemented using the structure_test library. The tests are defined as YAML files in the tests directory.

To run tests, use:

bazel test //...

We also have a set of formatting and style tests, which should be run before sending PRs. To run these, use:

make test

Note: running either set of tests requires installing container_diff and having it on your PATH.

How to become a contributor and submit your own code

Contributor License Agreements

We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.

Please fill out either the individual or corporate Contributor License Agreement (CLA).

  • If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

Contributing A Patch

  1. Submit an issue describing your proposed change to the repo in question.
  2. The repo owner will respond to your issue promptly.
  3. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
  4. Fork the desired repo, develop and test your code changes.
  5. Submit a pull request.