From bcea1116203042b22057c292ff6fadc29f4cd9aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alex=20Benn=C3=A9e?= Date: Mon, 7 Feb 2022 12:07:02 +0000 Subject: [PATCH] README.md: document repository coverage rules MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This attempts to finesse the rule of no coverage regressions for discussion with the wider community. Signed-off-by: Alex Bennée --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index f6922c3..c6860dd 100644 --- a/README.md +++ b/README.md @@ -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