Merge pull request #65 from chavafg/topic/document-pr-testing

docs: add CI info to CONTRIBUTING.md
This commit is contained in:
Graham Whaley 2018-10-04 14:53:08 +01:00 committed by GitHub
commit 0eb5bbd08f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -20,6 +20,7 @@
* [Supplementary patch](#supplementary-patch) * [Supplementary patch](#supplementary-patch)
* [Reviews](#reviews) * [Reviews](#reviews)
* [Examples](#examples) * [Examples](#examples)
* [Continuous Integration](#continuous-integration)
* [Contact](#contact) * [Contact](#contact)
* [Project maintainers](#project-maintainers) * [Project maintainers](#project-maintainers)
* [Issue tracking](#issue-tracking) * [Issue tracking](#issue-tracking)
@ -397,6 +398,27 @@ at the beginning of the line:
I love it! Very clean code and great tests. lgtm. 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 ## Contact
The Kata Containers community can be reached The Kata Containers community can be reached