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

Add README.md labels #109

Open
3 tasks
lotyp opened this issue May 30, 2024 · 0 comments
Open
3 tasks

Add README.md labels #109

lotyp opened this issue May 30, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation maintenance CI, dependencies etc

Comments

@lotyp
Copy link
Member

lotyp commented May 30, 2024

Description

As we now have mutation testing with the Stryker dashboard, we can enhance our README.md file with several badges to showcase our project's quality metrics.

Tasks

  1. Mutation Testing Badge:

    • Add a badge for mutation testing from the Stryker dashboard.
  2. Codecov Badge:

    • Integrate the Codecov badge to display our code coverage status.
  3. Static Analysis Badges:

    • Add badges for static analysis tools: Psalm and PHPStan.

Benefits

  • Improved Readability: These badges will provide at-a-glance information about the project's quality metrics.
  • Transparency: Helps contributors and users quickly understand the health of the codebase.
  • Encourages Contributions: A well-maintained project with visible metrics can attract more contributions.

References

Example Projects

https://github.com/wayofdev/php-cs-fixer-config/blob/master/.github/workflows/testing.yml

@lotyp lotyp added documentation Improvements or additions to documentation maintenance CI, dependencies etc labels May 30, 2024
@lotyp lotyp self-assigned this May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance CI, dependencies etc
Projects
None yet
Development

No branches or pull requests

1 participant