Investigate code coverage tools
Goal
Improve code coverage - aiding external readability, and improving the dev experience.
What needs to be done
Investigate and if suitable implement Compodocs coverage in pre-commit hooks and CI
https://compodoc.app/guides/documentation-coverage.html
This should run ONLY on staged files, as otherwise, it will fail on classes with no documentation.
QA
N/A
UX/Design
N/A
Personas
Existing / new developers and external developers browsing our stack on Gitlab.
Experiments
N/A
Acceptance Criteria
-
Evaluate whether Compodoc, Instanbul (or another tool) can do what we require -
Build out a coverage check if we can - start with maybe a 25% coverage requirement which on the surface seems a fair minimum. -
Check should only apply to staged files. (this way we build coverage on existing files) -
Add check to CI and pre-commit hooks as long as it is fast (<20s). -
On completion spawn another task to mirror the behavior for PHP
Definition of Ready Checklist
-
Definition Of Done (DoD) -
Acceptance criteria -
Weighted -
QA -
UX/Design -
Personas -
Experiments te
Edited by Mark Harding