diff options
| author | Andrey Orst <andreyorst@gmail.com> | 2020-11-01 17:55:21 +0300 |
|---|---|---|
| committer | Andrey Orst <andreyorst@gmail.com> | 2020-11-01 17:55:21 +0300 |
| commit | 3b9aa01b8b82f8710eb19fc829b937af42d9dbcb (patch) | |
| tree | 0e7934cad7cc528173244b4f7ea01a21c77c6476 /CONTRIBUTING.org | |
| parent | 62eec219d6697e1fd6347c07f27655b19d7a2ba7 (diff) | |
fix(doc): mention coverage measurement in contributing guidelines
Diffstat (limited to 'CONTRIBUTING.org')
| -rw-r--r-- | CONTRIBUTING.org | 4 |
1 files changed, 3 insertions, 1 deletions
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. |