github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-08-26 11:39:29 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #70 from ccollicutt/hook-fix

Browse Source 
docs: add note about virtcontainers if testing runtime
This commit is contained in:
James O. D. Hunt 2019-01-28 16:31:17 +00:00 committed by GitHub
commit d6cb46c2b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -75,8 +75,17 @@ Kata Containers utilizes a number of [CI systems](https://en.wikipedia.org/wiki/
to automatically check every PR. As well as performing execution tests locally on
your PR before submission, you are strongly encouraged to also run the same suite of
[static checks](https://github.com/kata-containers/tests/blob/master/.ci/static-checks.sh)
the CI will execute. The easiest way to execute these in most of the repositories is
to invoke the `Makefile` `check` and `test` rules, while developer mode is enabled:
the CI will execute.
> **Note:** If working on `kata-runtime`, first ensure `make` and `make install` has been run in the virtcontainers subdirectory. (See [virtcontainers](https://github.com/kata-containers/runtime/blob/master/virtcontainers/documentation/Developers.md#testing) documentation for more information.)
>
> ```sh
> $ cd runtime/virtcontainers
> $ make
> $ sudo -E PATH=$PATH make install
> ```
The easiest way to execute static checks in most of the repositories is to invoke the `Makefile` `check` and `test` rules, while developer mode is enabled.
```sh
$ export KATA_DEV_MODE=true