giada icon indicating copy to clipboard operation
giada copied to clipboard

Code Coverage badge/metric

Open lizzyd710 opened this issue 2 years ago • 1 comments

Is your feature request related to a problem? Please describe. I noticed that this repo has tests with the Catch2 framework but doesn't have any way to see how much of the repo is covered by these tests. For someone like me who would be interested in contributing by way of testing, it could help with giving people an idea of what needs to be done.

Describe the solution you'd like I think it would be helpful to have code coverage metrics shown on the README or somewhere else so that people can see how thoroughly tested the program is and how well the tests indicate full functionality.

Describe alternatives you've considered There's a few platforms I've seen used: Codecov, sonarcloud, etc. but obviously whatever one would work best with the project overall is great!

lizzyd710 avatar Jun 09 '22 13:06 lizzyd710

Hey @lizzyd710, this is a good suggestion. However, our test coverage is pretty low at the moment: I fear that adding that badge right now would backfire at us from a "marketing" point of view. Or maybe not, as you suggested?

Anyway I like this idea, I'm going to add it to the 1.x future milestone. Thanks!

gvnnz avatar Jun 11 '22 11:06 gvnnz