aljaz/kata-containers
1
0
Fork 0
mirror of https://github.com/aljazceru/kata-containers.git synced 2026-01-02 14:04:22 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
fe2311cd4cd3ab5655ba95e3017e30ad7604e4ce
kata-containers/src/runtime/virtcontainers/documentation/Developers.md
Peng Tao 1569b3b32a docs: fix static check errors 
Somehow we are not running static checks for a long time.
And that ended up with a lot for errors.

* Ensure debug options are valid is dropped
* fix snap links
* drop extra CONTRIBUTING.md
* reference kata-pkgsync
* move CODEOWNERS to proper place
* remove extra CODE_OF_CONDUCT.md.
* fix spell checker error on Developer-Guide.md

Signed-off-by: Peng Tao <bergwolf@hyper.sh>
2020-09-28 11:01:03 +08:00

1.1 KiB
Raw Blame History

Table of Contents

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.