mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-05 15:34:21 +01:00
1569b3b32a
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>
56 lines
1.1 KiB
Markdown
56 lines
1.1 KiB
Markdown
|
|
Table of Contents
|
|
=================
|
|
|
|
* [Prerequisites](#prerequisites)
|
|
* [Building](#building)
|
|
* [Testing](#testing)
|
|
* [Submitting changes](#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](../utils/virtcontainers-setup.sh) script.
|
|
|
|
# Building
|
|
|
|
To build `virtcontainers`, at the top level directory run:
|
|
|
|
```bash
|
|
# make
|
|
```
|
|
|
|
# Testing
|
|
|
|
Before testing `virtcontainers`, ensure you have met the [prerequisites](#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](../../../../CONTRIBUTING.md) document.
|
|
|