From 3b9aa01b8b82f8710eb19fc829b937af42d9dbcb Mon Sep 17 00:00:00 2001 From: Andrey Orst Date: Sun, 1 Nov 2020 17:55:21 +0300 Subject: fix(doc): mention coverage measurement in contributing guidelines --- CONTRIBUTING.org | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'CONTRIBUTING.org') diff --git a/CONTRIBUTING.org b/CONTRIBUTING.org index 487c3f9..f1bcbef 100644 --- a/CONTRIBUTING.org +++ b/CONTRIBUTING.org @@ -45,7 +45,9 @@ When changing existing functions make sure that all tests pass. If some tests do not pass, make sure that these tests are written to test this function. If not, then, perhaps, you've broke something horribly. -Before comitting changes you must run tests with =Make test=, and all of the tests must pass without errors. +Before comitting changes you must run tests with =make test=, and all of the tests must pass without errors. +Consider checking test coverage with =make luacov= and rendering it with your preferred reporter. +Makefile also has =luacov-console= target, which can be used to see coverage of lua code directly in the terminal. ** Writing documentation If you've added new code, make sure it is covered not only by tests but also with documentation. -- cgit v1.2.3