Skip to content

docs: add sonar badge to project readme files, fix codecov badge, and update headings #168

Description

@ReenigneArcher

Is there an existing issue for this item?

  • I have searched the existing issues

Repositories

No response

Languages/Skills/Technologies

Markdown, HTML

Description

Uplift readme files with the following changes.

  • Add sonarcloud badge
  • Add/update codecov badge to our pre-fetched data (avoiding using codecov token in readme and ratelimiting)
  • Update headings

html heading:

<div align="center">
  <img
    src="https://raw.githubusercontent.com/LizardByte/.github/refs/heads/master/branding/logos/logo.svg"
    alt="LizardByte icon"
    width="256"
  />
  <h1 align="center">repo-name</h1>
  <h4 align="center">Repo description. This should exactly match the description in GitHub.</h4>
</div>

<div align="center">
  <a href="https://codecov.io/gh/LizardByte/template-base"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fapp.lizardbyte.dev%2Fdashboard%2Fshields%2Fcodecov%2Ftemplate-base.json&style=for-the-badge&logo=codecov" alt="Codecov"></a>
  <a href="https://sonarcloud.io/project/overview?id=LizardByte_template-base"><img src="https://img.shields.io/sonar/quality_gate/LizardByte_template-base?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarcloud" alt="SonarCloud"></a>
</div>

Codecov badge can be omitted if we have no coverage data for the repo.

Repositories:

Estimated Effort

effort:Medium

Priority

priority:Low

Target Milestone

1-3 months

Dependencies

No response

Metadata

Metadata

Type

No fields configured for Task.

Projects

Status
In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions