Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the simplecov requirement for promoting Core Components #126

Open
jrgriffiniii opened this issue Jun 22, 2022 · 2 comments
Open

Remove the simplecov requirement for promoting Core Components #126

jrgriffiniii opened this issue Jun 22, 2022 · 2 comments

Comments

@jrgriffiniii
Copy link
Contributor

As the requirements for Core Components have been shifting from the time at which the original guidelines have shifted, this issue is a request to deprecate two related requirements for promotion:

  1. Good unit test coverage measured by community (e.g. 100% or 75% of what’s important)
  2. uses Coverage tool (coveralls or simplecov)

coveralls has been unreliable with regards to the analysis of code coverage analysis in past maintenance contributions, which simplecov has also presented issues regarding the threshold coverage at which each Gem should be maintained.

Further, there exist cases in which, due to the shift in available labor needed to increase or maintain the recommended 75%-100% threshold, this will render promoting components where required will become impossible. One such example is https://github.com/samvera/active_fedora, where the coverage is currently reported as 65%: https://coveralls.io/github/samvera/active_fedora?branch=main.

Removing these requirements would also ensure that all newer contributors need not feel obligated to configure code coverage analysis tools such as simplecov, and can instead focus upon crucial elements of functionality within the code base.

@jrgriffiniii jrgriffiniii changed the title Remove the simplecov requirements for promoting Core Components Remove the simplecov requirement for promoting Core Components Jun 22, 2022
@jrochkind
Copy link

+1

I'm curious if anyone can even figure out what simplecov currently reports for hyrax, where it is theoretically configured.

I think few if anyone have been using these reports for some time; as we try to maintain some legacy gems we are running into trouble where simplecov isn't working, easier to remove it than to spend time trying to fix it if it's not providing much value. See samvera/questioning_authority#362 and samvera/browse-everything#401

@jrgriffiniii jrgriffiniii self-assigned this Jun 23, 2022
@jrgriffiniii
Copy link
Contributor Author

After reviewing https://github.com/simplecov-ruby/simplecov, I can perhaps also augment this with a proposed set of recommendations for analyzing test coverage and persisting test coverage reports for CircleCI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

2 participants