Skip to content

Add Professional Badges to README #21

@TumeloKonaite

Description

@TumeloKonaite

Summary
The README currently lacks project badges that show build status, code coverage, licensing, release information, and code style. Adding these badges will improve the project’s professionalism, credibility, and transparency as an open-source repository.

Proposed Solution
Add a badge block at the top of the README including:

  • GitHub Actions build status
  • Codecov coverage badge
  • Latest release badge
  • License badge
  • Code style (Black)
  • Linting (Ruff)
  • Optional: issues, pull requests, contributors

These badges help communicate project health and make the repository more attractive to contributors.

Impact
Improves first impressions, enhances trust for users and contributors, and aligns with open-source best practices.

Priority
Low to Medium — small change but high visual impact.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions