Skip to content

Add status badges to README#22

Merged
mnaimfaizy merged 3 commits intomainfrom
copilot/add-badges-to-readme
Dec 22, 2025
Merged

Add status badges to README#22
mnaimfaizy merged 3 commits intomainfrom
copilot/add-badges-to-readme

Conversation

Copy link
Contributor

Copilot AI commented Dec 22, 2025

Adds professional status badges to showcase CI/CD workflows, technology stack, and project health metrics.

Changes

CI/CD Status Badges

  • Backend CI (linting, type checking, unit tests)
  • Frontend CI (linting, formatting, build)
  • Docker multi-arch image publishing
  • Documentation deployment

Stack & Quality Badges

  • MIT license
  • Python 3.10+, FastAPI 0.115+, React 18+, TypeScript 5+

Project Health Badges

  • Docker Hub pull statistics (backend/frontend)
  • Live documentation status
  • Active maintenance indicator

Note: Codecov badge was initially added but removed as it was displaying "undefined" - the integration needs to be configured before adding this badge.

Implementation

Badges positioned below logo, organized in 3 rows for scanability. All badges link to relevant resources (workflow runs, Docker Hub, documentation).

<div align="center">

[![Backend CI](https://github.com/mnaimfaizy/fastapi_rbac/actions/workflows/backend-ci.yml/badge.svg)](...)
[![React Frontend CI](https://github.com/mnaimfaizy/fastapi_rbac/actions/workflows/react-frontend-ci.yml/badge.svg)](...)
...

</div>

Updated badges

Original prompt

In order to properly show the users that we are passing the tests, linting and build of the repository and it's containing projects. I would like you to search and include proper badges in the repository's README.md file like the other professional respositories are having.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Add comprehensive status badges to showcase:
- CI/CD workflows (Backend CI, Frontend CI, Docker Publish, Documentation)
- Code coverage (Codecov integration)
- License information (MIT)
- Technology stack (Python 3.10+, FastAPI 0.115+, React 18+, TypeScript 5+)
- Docker Hub pull statistics
- Documentation status
- Maintenance status

Badges are organized in three logical groups:
1. GitHub Actions workflow statuses
2. Code quality, license, and technology stack
3. Docker Hub stats and project health indicators

All badges include proper links to relevant resources for easy navigation.

Co-authored-by: mnaimfaizy <34773846+mnaimfaizy@users.noreply.github.com>
Copilot AI changed the title [WIP] Add badges for tests, linting, and build status Add status badges to README Dec 22, 2025
Copilot AI requested a review from mnaimfaizy December 22, 2025 00:36
Remove codecov badge as it was displaying "undefined" indicating that
codecov integration is not fully configured for the repository yet.
The badge can be re-added once codecov is properly set up with the
repository and coverage reports are being uploaded successfully.

Co-authored-by: mnaimfaizy <34773846+mnaimfaizy@users.noreply.github.com>
Copy link
Owner

@mnaimfaizy mnaimfaizy left a comment

Choose a reason for hiding this comment

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

@copilot Please go through my comments and do accordingly.

@mnaimfaizy mnaimfaizy merged commit 4d9fc04 into main Dec 22, 2025
3 checks passed
@mnaimfaizy mnaimfaizy deleted the copilot/add-badges-to-readme branch December 22, 2025 04:04
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.

2 participants