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

docs: adds a code coverage badge to the README #233

Merged
merged 1 commit into from
Dec 27, 2020

Conversation

thawkin3
Copy link
Contributor

I've added a code coverage badge from Codecov to the README. This repo has 97% code coverage through the Jest unit tests, so we may as well flaunt it. Behold!

Screen Shot 2020-12-26 at 10 03 10 PM

PR Checklist

Please leave this checklist in your PR.

  • Issue being fixed is referenced.
  • Source changes maintain:
    • Stated browser compatibility.
    • Stated React compatibility.
  • Unit test coverage added/updated.
  • E2E test coverage added/updated.
  • Prop-types added/updated.
  • Typings added/updated.
  • README updated (API changes, instructions, etc.).
  • Changes to dependencies explained.
  • Changeset added (run yarn changeset locally to add one, and follow the prompts).
    • EXCEPTION: A Changeset is not required if the change does not affect any of the source files that produce the package bundle. For example, tooling changes, test updates, or a new dev-only dependency to run tests more efficiently should not have a Changeset since it will not affect package consumers.

@changeset-bot
Copy link

changeset-bot bot commented Dec 27, 2020

⚠️ No Changeset found

Latest commit: 46bb7f2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@codecov
Copy link

codecov bot commented Dec 27, 2020

Codecov Report

Merging #233 (46bb7f2) into master (9d11b09) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #233   +/-   ##
=======================================
  Coverage   97.14%   97.14%           
=======================================
  Files           1        1           
  Lines          70       70           
  Branches       26       26           
=======================================
  Hits           68       68           
  Misses          2        2           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d11b09...46bb7f2. Read the comment docs.

@maraisr maraisr merged commit a9d20d9 into focus-trap:master Dec 27, 2020
@thawkin3 thawkin3 deleted the feature/codecov-badge branch December 27, 2020 21:24
@thawkin3
Copy link
Contributor Author

Thanks for merging this so quickly!

@thawkin3
Copy link
Contributor Author

@all-contributors please add @thawkin3 for docs

@allcontributors
Copy link
Contributor

@thawkin3

I've put up a pull request to add @thawkin3! 🎉

@stefcameron
Copy link
Member

@thawkin3 Thanks for adding the badge! For sure, we should highlight that. I forgot the badge when I integrated the bot.

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

Successfully merging this pull request may close these issues.

3 participants