Skip to content

docs: Add test coverage badge to README (#500)#867

Open
Bhagyashri77777 wants to merge 21 commits into
imDarshanGK:mainfrom
Bhagyashri77777:add-coverage-badge-500
Open

docs: Add test coverage badge to README (#500)#867
Bhagyashri77777 wants to merge 21 commits into
imDarshanGK:mainfrom
Bhagyashri77777:add-coverage-badge-500

Conversation

@Bhagyashri77777

Copy link
Copy Markdown
Contributor

Hi @imDarshanGK,
I have added the Codecov badge to the README.md as requested in issue #500. This will track the test coverage once fully integrated into the CI pipeline.
Let me know if you need any changes!
Fixes #500

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Hi @imDarshanGK!

Just wanted to give a quick update: I have successfully submitted the Pull Request (#867) to add the Codecov test coverage badge!

Looking forward to your review. Please let me know if any further changes are needed. Thank you!

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@Bhagyashri77777 not working and add demo

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Hi @imDarshanGK, thanks for the review!

Regarding the requested changes:

  1. Demo: I will take a screenshot of the live site, add it to the assets/ folder as preview.png, and uncomment the Preview section in the README.md.
  2. Coverage Badge: The Codecov badge currently shows as "not working/unknown" because the ci.yml workflow runs standard pytest but isn't generating or uploading coverage reports yet (e.g., using pytest-cov).

Would you like me to add the coverage generation steps to the GitHub Actions CI as part of this PR so the badge activates? Or do you have a different coverage tool in mind? Let me know and I will update it immediately!

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Hi @imDarshanGK, I have pushed the requested updates!

  1. Added the clean, full-screen demo screenshot (preview.png) and uncommented the Preview section in the README.
  2. The Codecov badge is also added and ready to track coverage once the CI pipeline starts uploading reports.

Let me know if it looks good to merge!

@imDarshanGK

Copy link
Copy Markdown
Owner

@Bhagyashri77777 remove this file assets/preview.png

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Thank you so much for assigning these issues to me! I am really like working on this issue
​I just wanted to give a quick heads-up that my university end-semester exams are currently ongoing, with papers scheduled for the 15th and 17th of June.
​Would it be alright if I take a pause and start submitting my PRs after the 17th? I will have a clear window before my next exam and will be fully dedicated to solving these issues step-by-step from the 18th onwards.
​Thank you for your time and understanding!

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

This PR has very large unnecessary changes (+567/-566) for a simple coverage badge task. Please keep changes minimal and only update README with the badge + add a demo/screenshot showing it working.

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@Bhagyashri77777
This is enough. Please don't make any other changes. Just add a screenshot or screen recording showing the feature working.
Image

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Hi @imDarshanGK, I switched to the feature branch and here is the screenshot showing the Codecov badge successfully rendering on the README!
Screenshot 2026-06-26 202133
Let me know if we are good to go

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@Bhagyashri77777 This is enough. Please don't add any other changes

Image

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Understood! I won't make any more changes. I have updated the branch as well. Could you please approve the PR now so it can be merged? Thank you so much for your patience!

@imDarshanGK imDarshanGK left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

@Bhagyashri77777 Why did you delete it without any reason?

Image

@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Hi @imDarshanGK, I am so sorry about that! I had a silly Git merge conflict earlier and accidentally deleted those sections without realizing it. I am currently at college without my laptop, but I will completely restore the README.md and make sure ONLY the Codecov badge is added tonight as soon as I am back. Thank you so much for catching that and for your patience!

Updated instructions for cloning the repository and running Docker commands. Improved formatting for service descriptions and added steps for verifying the application.
@Bhagyashri77777

Copy link
Copy Markdown
Contributor Author

Hi @imDarshanGK! I have completely fixed the PR! It is now perfectly clean with zero deletions, and it ONLY adds the single Codecov badge exactly as you requested. Thank you so much for your amazing patience and for guiding me through this! Please let me know if we are ready to merge!

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.

Add test coverage badge to README

2 participants