From b17082b8e97e0cb2cd2652b61b0b29d73ddb1a36 Mon Sep 17 00:00:00 2001 From: Simone Basso Date: Sat, 5 Feb 2022 12:21:22 +0100 Subject: [PATCH] fix(CONTRIBUTING.md): mention that some tests may be flaky In particular, mention that `jafar` is painful to test under Linux. We know that and we'll eventually also replace `jafar`. But better to tell this to newcomers otherwise their testing experience would be not so pleasant. --- CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9a2085..54c6009 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,7 +71,10 @@ and `./internal/netxlite.CopyContext` instead of `io.Copy` ## Code testing requirements Make sure all tests pass with `go test -race ./...` run from the -top-level directory of this repository. +top-level directory of this repository. (Integration tests may be +flaky, so there may be some failures here and and there; we know +in particular that `./internal/cmd/jafar` is one of the usual +suspects and that it's not super pleasant to test it under Linux.) ## Writing a new OONI experiment