WayScience / coSMicQC

Single cell Morphology Quality Control (coSMicQC)
https://wayscience.github.io/coSMicQC/
BSD 3-Clause "New" or "Revised" License
7 stars 3 forks source link

Add code coverage badge through coverage.py #63

Closed d33bs closed 3 months ago

d33bs commented 4 months ago

Description

This PR adds a code coverage badge to the readme by running coverage.py through pytests, generating a report, and then generating a badge. Any changes to the coverage should change this file in future PR's.

Additionally:

Closes #60

What kind of change(s) are included?

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

d33bs commented 3 months ago

Thank you @jenna-tomkinson ! Addressing your question:

I was wondering why the change from logo to media, is this a specific standard the packages tend to follow?

I think of it like I do modules or classes: when there's one "thing" or "object" it's okay to keep things specific. Once there's more than one "thing" it's useful to create an abstraction to house those "things" in some sort of hierarchy to reduce the amount of "horizontal" spread (really, to reduce the complexity of looking through the repo and its contents). Keep in mind there are contrasting opinions about these things - some prefer nesting with directories and files, others prefer single-directory structures (placing everything into a single directory). I tend to practice nesting, but this doesn't mean it's perfect!

In this case we had one "thing" (the logo code and images). The changes in this PR added another "thing" (the code coverage badge image). As a result I created the abstraction of "media" to help organize these things instead of having two folders for similar but different things. I don't know that there's a standard when it comes to this, I think I picked up on media from earlier web framework experiences, but I'm not sure! I have a feeling these may be better suited to go into the docs folder somewhere eventually, but I don't know exactly where yet because we haven't selected a docs framework or strategy (which would inform where it goes).

Thanks again, merging this in!