Skip to content

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Nov 15, 2025

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.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Something else

Scope

  • This PR comprises a set of related changes with a common goal

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 A
  • Test B

Test Configuration:

  • What computers and compilers did you use to test this:

Checklist

  • I have added comments for the new code
  • I added Doxygen docstrings to the new code
  • I have made corresponding changes to the documentation (docs/)
  • I have added regression tests to the test suite so that people can verify in the future that the feature is behaving as expected
  • I have added example cases in examples/ that demonstrate my new feature performing as expected.
    They run to completion and demonstrate "interesting physics"
  • I ran ./mfc.sh format before committing my code
  • New and existing tests pass locally with my changes, including with GPU capability enabled (both NVIDIA hardware with NVHPC compilers and AMD hardware with CRAY compilers) and disabled
  • This PR does not introduce any repeated code (it follows the DRY principle)
  • I cannot think of a way to condense this code and reduce any introduced additional line count

If 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:

  • Checked that the code compiles using NVHPC compilers
  • Checked that the code compiles using CRAY compilers
  • Ran the code on either V100, A100, or H100 GPUs and ensured the new feature performed as expected (the GPU results match the CPU results)
  • Ran the code on MI200+ GPUs and ensure the new features performed as expected (the GPU results match the CPU results)
  • Enclosed the new feature via nvtx ranges so that they can be identified in profiles
  • Ran a Nsight Systems profile using ./mfc.sh run XXXX --gpu -t simulation --nsys, and have attached the output file (.nsys-rep) and plain text results to this PR
  • Ran a Rocprof Systems profile using ./mfc.sh run XXXX --gpu -t simulation --rsys --hip-trace, and have attached the output file and plain text results to this PR.
  • Ran my code using various numbers of different GPUs (1, 2, and 8, for example) in parallel and made sure that the results scale similarly to what happens if you run without the new code/feature

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

flowchart LR
  README["README.md"] -->|Update Codespaces badge| Badge1["Simplified badge text"]
  README -->|Add Docker Hub badge| Badge2["New Docker Hub link"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Update README badges for Codespaces and Docker Hub             

README.md

  • Modified Codespaces badge text to be more concise ("Open in 1 click" →
    "Open")
  • Added new Docker Hub badge with link to sbryngelson/mfc repository
  • Badge uses shields.io styling with Docker logo
+5/-1     

Updated Codespaces badge and added Docker Hub badge.
Copilot AI review requested due to automatic review settings November 15, 2025 15:01
@sbryngelson sbryngelson merged commit 37560f1 into master Nov 15, 2025
28 checks passed
@sbryngelson sbryngelson deleted the sbryngelson-patch-1 branch November 15, 2025 15:02
@qodo-merge-pro
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Badge Link Accuracy

Verify that the new Docker Hub link and the updated Codespaces badge render correctly and point to the intended targets in preview and on GitHub.

  <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" />
</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>	
Visual Consistency

Check badge styling consistency (colors, style=flat, logo capitalization) with existing badges to maintain a uniform look.

  <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" />
</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>	

<a href="https://github.com/MFlowCode/homebrew-mfc">
  <img src="https://img.shields.io/badge/homebrew-mflowcode%2Fmfc%2Fmfc-brown?logo=homebrew&style=flat" />
</a>	

@qodo-merge-pro
Copy link
Contributor

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
Not applicable: This PR only modifies README badges and introduces no code paths where critical actions
could be logged, so audit trail compliance cannot be assessed from the added lines.

Referred Code
  <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" />
</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>	

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Not applicable: The change only updates static README content; no executable logic or error handling was
added, so compliance cannot be evaluated from these lines.

Referred Code
  <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" />
</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>	

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status:
Not applicable: Only documentation badges and links were added; there is no input handling or data
processing in the diff to assess validation or security controls.

Referred Code
  <img src="https://img.shields.io/badge/Codespaces-Open-2ea44f?logo=github" />
</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>	

Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

Comment on lines +38 to +40
<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>
Copy link
Contributor

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]

Suggested change
<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" />
Copy link
Contributor

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]

Suggested change
<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" />

Copilot finished reviewing on behalf of sbryngelson November 15, 2025 15:02
Copy link
Contributor

Copilot AI left a 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>
Copy link

Copilot AI Nov 15, 2025

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.

Suggested change
</a>
</a>

Copilot uses AI. Check for mistakes.
<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>

Copy link

Copilot AI Nov 15, 2025

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.

Suggested change

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants