Merge pull request #103 from stsquad/docs/coverage

Docs/coverage
This commit is contained in:
Viresh Kumar 2022-02-10 02:27:40 +05:30 committed by GitHub
commit 7efc5be7e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,6 +10,20 @@ Here is the list of device backends that we support:
- [I2C](https://github.com/rust-vmm/vhost-device/blob/main/i2c/README.md)
## Testing and Code Coverage
Like the wider rust-vmm project we expect new features to come with
comprehensive code coverage. However as a multi-binary repository
there are cases where avoiding a drop in coverage can be hard and an
exception to the approach is allowable. These are:
* adding a new binary target (aim at least 60% overall coverage)
* expanding the main function (a small drop is acceptable)
However any new feature added to an existing binary should not cause a
drop in coverage. The general aim should be to always improve
coverage.
## Separation of Concerns
The binaries built by this repository can be run with any VMM which