-
Notifications
You must be signed in to change notification settings - Fork 121
Modify badges in README.md #1050
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
Conversation
Updated Codespaces badge and added Docker Hub badge.
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||||||||
| <a href="https://hub.docker.com/r/sbryngelson/mfc"> | ||
| <img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker&style=flat" /> | ||
| </a> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Replace the static Docker Hub badge with a dynamic one from shields.io to show pull counts, and add an alt attribute for accessibility. [general, importance: 6]
| <a href="https://hub.docker.com/r/sbryngelson/mfc"> | |
| <img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker&style=flat" /> | |
| </a> | |
| <a href="https://hub.docker.com/r/sbryngelson/mfc"> | |
| <img src="https://img.shields.io/docker/pulls/sbryngelson/mfc?logo=docker&style=flat" alt="Docker Pulls" /> | |
| </a> |
| </a> | ||
| <a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=MFlowCode%2FMFC"> | ||
| <img src="https://img.shields.io/badge/Codespaces-Open%20in%201%20click-2ea44f?logo=github" /> | ||
| <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion: Add an alt attribute to the Codespaces <img> tag to improve accessibility by providing a text alternative for screen readers. [general, importance: 4]
| <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" /> | |
| <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" alt="Open in GitHub Codespaces" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the README.md badges section by modernizing the Codespaces badge text and adding a new Docker Hub badge to improve discoverability of container images.
- Simplified Codespaces badge label from "Open in 1 click" to "Open"
- Added Docker Hub badge linking to the MFC container repository
| </a> | ||
| <a href="https://hub.docker.com/r/sbryngelson/mfc"> | ||
| <img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker&style=flat" /> | ||
| </a> |
Copilot
AI
Nov 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line contains trailing whitespace (a tab character after the closing </a> tag). Please remove the trailing tab character to maintain clean formatting.
| </a> | |
| </a> |
| <a href="https://hub.docker.com/r/sbryngelson/mfc"> | ||
| <img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker&style=flat" /> | ||
| </a> | ||
|
|
Copilot
AI
Nov 15, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line contains only a tab character with no other content. Please remove this line as it adds unnecessary whitespace to the file.
User description
Updated Codespaces badge and added Docker Hub badge.
Description
Please include a summary of the changes and the related issue(s) if they exist.
Please also include relevant motivation and context.
Fixes #(issue) [optional]
Type of change
Please delete options that are not relevant.
Scope
If you cannot check the above box, please split your PR into multiple PRs that each have a common goal.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration
Test Configuration:
Checklist
docs/)examples/that demonstrate my new feature performing as expected.They run to completion and demonstrate "interesting physics"
./mfc.sh formatbefore committing my codeIf your code changes any code source files (anything in
src/simulation)To make sure the code is performing as expected on GPU devices, I have:
nvtxranges so that they can be identified in profiles./mfc.sh run XXXX --gpu -t simulation --nsys, and have attached the output file (.nsys-rep) and plain text results to this PR./mfc.sh run XXXX --gpu -t simulation --rsys --hip-trace, and have attached the output file and plain text results to this PR.PR Type
Documentation
Description
Updated Codespaces badge text from "Open in 1 click" to "Open"
Added new Docker Hub badge linking to sbryngelson/mfc repository
Diagram Walkthrough
File Walkthrough
README.md
Update README badges for Codespaces and Docker HubREADME.md
"Open")