From 41a21903c1135d162b2cc360d0423c670199546d Mon Sep 17 00:00:00 2001 From: Salvador Fuentes Date: Mon, 24 Sep 2018 13:09:03 -0500 Subject: [PATCH] docs: add CI info to CONTRIBUTING.md Info about how the CI works when a PR is opened. Signed-off-by: Salvador Fuentes --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 204ed12f77..83b81f29bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,6 +19,7 @@ * [Supplementary patch](#supplementary-patch) * [Reviews](#reviews) * [Examples](#examples) +* [Continuous Integration](#continuous-integration) * [Contact](#contact) * [Project maintainers](#project-maintainers) * [Issue tracking](#issue-tracking) @@ -368,6 +369,27 @@ at the beginning of the line: I love it! Very clean code and great tests. lgtm. ``` +## Continuous Integration + +The Kata Containers project has a gating process to prevent introducing +regressions. When your PR is submitted, a Continuous Integration (CI) system +will run different checks on different platforms upon your changes. Currently +Kata uses [Jenkins](http://jenkins.katacontainers.io) and +[Travis CI](https://travis-ci.org/kata-containers/) for testing your changes. + +Some of the checks are: + +- Static analysis checks. +- Unit tests. +- Functional tests. +- Integretation tests. + +The travis job will be executed right after the PR is opened, while the Jenkins +jobs will wait to be triggered. A maintainer must add a `/test` comment +on the PR to let the CI jobs run. + +All CI jobs must pass in order to merge your PR. + ## Contact The Kata Containers community can be reached