Developers.md

Table of Contents

• Prerequisites
• Building
• Testing
• Submitting changes

Prerequisites

virtcontainers has a few prerequisites for development:

• docker
• CNI
• golang

A number of these can be installed using the virtcontainers-setup.sh script.

Building

To build virtcontainers, at the top level directory run:

# make

Testing

Before testing virtcontainers, ensure you have met the prerequisites.

Before testing you need to install virtcontainers. The following command will install virtcontainers into its own area (/usr/bin/virtcontainers/bin/ by default).

# sudo -E PATH=$PATH make install

To test virtcontainers, at the top level run:

# make check

This will:

• run static code checks on the code base.
• run go test unit tests from the code base.

Submitting changes

For details on the format and how to submit changes, refer to the Contributing document.