Skip to content

chore(readme): add badge #284

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

Merged
merged 2 commits into from
May 28, 2025
Merged

chore(readme): add badge #284

merged 2 commits into from
May 28, 2025

Conversation

AugustinMauroy
Copy link
Member

Description

  • Add codecov badge to display the code coverage on the readme
  • Add "CII-Best-Practices" badge which is required by OpenSSF scorecard

Related Issues

No related issues, I just noticed this

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • NA I have run node --run test and all tests passed.
  • NA I have check code formatting with node --run format & node --run lint.
  • NA I've covered new added functionality with unit tests if necessary.

@AugustinMauroy AugustinMauroy requested a review from a team as a code owner May 28, 2025 08:30
@codecov-commenter
Copy link

codecov-commenter commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.31%. Comparing base (32834c4) to head (eac8410).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #284   +/-   ##
=======================================
  Coverage   91.31%   91.31%           
=======================================
  Files          51       51           
  Lines        3674     3674           
  Branches      166      166           
=======================================
  Hits         3355     3355           
  Misses        318      318           
  Partials        1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AugustinMauroy AugustinMauroy requested a review from Copilot May 28, 2025 08:32
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds visibility metrics to the project’s README by including badges for code coverage and best practices scoring.

  • Insert Codecov badge with coverage graph
  • Insert CII Best Practices badge

@ovflowd ovflowd merged commit 37c3202 into main May 28, 2025
8 checks passed
@ovflowd ovflowd deleted the chore(readme)-add-badge branch May 28, 2025 13:06
@ovflowd
Copy link
Member

ovflowd commented May 28, 2025

Fast-tracking due to the nature of this change.

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.

5 participants