Skip to content

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Nov 12, 2025

User description

yep


PR Type

Bug fix, Documentation


Description

  • Fixed badge link by removing invalid sort=semver parameter

  • Added dark theme to star history chart for better visibility

  • Updated Homebrew installation command to use mfc directly

  • Corrected Homebrew section header formatting


Diagram Walkthrough

flowchart LR
  A["README.md"] -->|Remove sort parameter| B["Release badge fixed"]
  A -->|Add dark theme| C["Star history improved"]
  A -->|Simplify command| D["Homebrew command updated"]
Loading

File Walkthrough

Relevant files
Bug fix, documentation
README.md
Fix badges and update Homebrew command                                     

README.md

  • Removed invalid sort=semver parameter from GitHub release badge URL
  • Added &theme=dark parameter to star history chart API for dark theme
    support
  • Updated Homebrew installation command from mfc run to mfc for direct
    execution
  • Fixed Homebrew section header formatting by moving macOS label outside
    parentheses
+3/-3     

Note

Updates README badges and adjusts the Homebrew quickstart command syntax.

  • README:
    • Badges:
      • Release badge: remove sort=semver parameter in https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release.
      • Star history chart: add &theme=dark to https://api.star-history.com/svg image.
    • Quickstart (Homebrew):
      • Update example command by removing run subcommand: mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2.

Written by Cursor Bugbot for commit 2da7f3e. Configure here.

Copilot AI review requested due to automatic review settings November 12, 2025 15:00
@sbryngelson sbryngelson merged commit d5e7059 into MFlowCode:master Nov 12, 2025
17 checks passed
@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

Possible Issue

Removing the 'sort=semver' parameter from the release badge may change which version is displayed; verify shields.io defaults match intended behavior.

  <img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release" />
</a>
Link Behavior

The star-history image now requests a 'theme=dark' SVG while the link opens star-history.com; ensure the theme aligns with the site's background and the external link renders as expected.

<a href="https://star-history.com/#MFlowCode/MFC&Date">
  <img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date&theme=dark" alt="Star History Chart" width="600"/>
</a>
Command Accuracy

The Homebrew example changed from 'mfc run' to plain 'mfc'; validate that the CLI subcommand is not required and that the example path exists post-brew install.

| **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |

@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 Scope: The PR only updates README badges and commands without adding runtime code where audit
logging would apply, so no critical actions can be assessed here.

Referred Code
    <img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release" />
  </a>
</p>

<p align="center">
  <a href="https://star-history.com/#MFlowCode/MFC&Date">
    <img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date&theme=dark" alt="Star History Chart" width="600"/>
  </a>
</p>

> **If MFC helps your work, please ⭐ the repo and cite it!**

### Who uses MFC

MFC runs at exascale on the world's fastest supercomputers:
- **OLCF Frontier** (>33K AMD MI250X GPUs)
- **LLNL El Capitan** (>43K AMD MI300A APUs)
- **LLNL Tuolumne**, **CSCS Alps**, and many others

### Try MFC



 ... (clipped 5 lines)

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:
No Runtime Errors: Documentation-only changes do not introduce executable error paths; robustness cannot be
evaluated from README updates alone.

Referred Code
    <img src="https://img.shields.io/github/v/release/MFlowCode/MFC?display_name=release" />
  </a>
</p>

<p align="center">
  <a href="https://star-history.com/#MFlowCode/MFC&Date">
    <img src="https://api.star-history.com/svg?repos=MFlowCode/MFC&type=Date&theme=dark" alt="Star History Chart" width="600"/>
  </a>
</p>

> **If MFC helps your work, please ⭐ the repo and cite it!**

### Who uses MFC

MFC runs at exascale on the world's fastest supercomputers:
- **OLCF Frontier** (>33K AMD MI250X GPUs)
- **LLNL El Capitan** (>43K AMD MI300A APUs)
- **LLNL Tuolumne**, **CSCS Alps**, and many others

### Try MFC



 ... (clipped 5 lines)

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:
No Input Surface: The changes modify documentation and shell command examples only, with no new input
handling code to validate for security concerns.

Referred Code
| Path | Command |
| --- | --- |
| **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click |
| **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Local build** | `./mfc.sh build -j $(nproc) && ./mfc.sh test -j $(nproc)` |

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

@qodo-merge-pro
Copy link
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

Copilot finished reviewing on behalf of sbryngelson November 12, 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 badge URLs and the Homebrew installation command in the README. The changes include removing the sort=semver parameter from the release badge, adding a dark theme to the star history chart, and shortening the Homebrew command from mfc run to mfc.

  • Removes sort=semver parameter from the GitHub release badge URL
  • Adds theme=dark parameter to the star history chart
  • Simplifies Homebrew command by removing the explicit run subcommand

| --- | --- |
| **Codespaces** (fastest) | Click the "Codespaces" badge above to launch in 1 click |
| **Homebrew (macOS)** | `brew install mflowcode/mfc/mfc && mfc run $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

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

The Homebrew command was changed from mfc run to just mfc, but this creates inconsistency with the rest of the documentation. Lines 149 in this same file, as well as docs/documentation/getting-started.md (line 26), docs/documentation/running.md (line 16), and packaging/homebrew/README.md (line 18) all use mfc run. While both forms are technically valid according to the Homebrew formula, it would be better to maintain consistency across all documentation. Consider either keeping mfc run here or updating all other locations to match.

Suggested change
| **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |
| **Homebrew** (macOS) | `brew install mflowcode/mfc/mfc && mfc run $(brew --prefix mfc)/examples/1D_sodshocktube/case.py -n 2` |

Copilot uses AI. Check for mistakes.
sbryngelson added a commit to sbryngelson/MFC that referenced this pull request Nov 12, 2025
- Use shorthand 'mfc case.py' consistently across all documentation
- Clarify that both 'mfc case.py' and 'mfc run case.py' work
- Update README.md, packaging/homebrew/README.md, getting-started.md, and running.md
- Improves consistency and showcases the smart detection feature

Addresses Copilot AI review comment about documentation inconsistency
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.

1 participant