Skip to content

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Jul 7, 2025

User description

Adds a badge to readme


PR Type

Documentation


Description

  • Add contributing guide badge to README

Changes diagram

flowchart LR
  A["README.md"] --> B["Add Contributing Badge"]
  B --> C["Link to CONTRIBUTING.md"]
Loading

Changes walkthrough 📝

Relevant files
Documentation
README.md
Add contributing guide badge                                                         

README.md

  • Add new contributing guide badge with orange styling
  • Link badge to .github/CONTRIBUTING.md file
  • +3/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • Copilot AI review requested due to automatic review settings July 7, 2025 14:20
    @qodo-code-review
    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

    Broken Link

    The badge links to a hardcoded master branch path which may break if the default branch is renamed or if the CONTRIBUTING.md file is moved. Consider using a relative path or dynamic branch reference.

    <a href="https://github.com/MFlowCode/MFC/blob/master/.github/CONTRIBUTING.md" target="_blank">
      <img src="https://img.shields.io/badge/Contributing-Guide-orange?style=flat">
    </a>
    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

    Adds a contributing guide badge to the project’s README, giving visitors quick access to contribution instructions.

    • Inserts a link and badge pointing to the .github/CONTRIBUTING.md file.
    • Ensures the badge matches the style of existing shields.
    Comments suppressed due to low confidence (1)

    README.md:23

    • The link uses /blob/master/ but the default branch appears to be main. Consider updating the URL to /blob/main/.github/CONTRIBUTING.md to prevent a broken link.
      <a href="https://github.com/MFlowCode/MFC/blob/master/.github/CONTRIBUTING.md" target="_blank">
    
    @qodo-code-review
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Use relative path for links

    The link uses a hardcoded branch reference 'master' which may break if the
    default branch changes. Use a relative path instead to ensure the link always
    points to the current branch.

    README.md [23-25]

    -<a href="https://github.com/MFlowCode/MFC/blob/master/.github/CONTRIBUTING.md" target="_blank">
    +<a href=".github/CONTRIBUTING.md" target="_blank">
       <img src="https://img.shields.io/badge/Contributing-Guide-orange?style=flat">
     </a>
    Suggestion importance[1-10]: 6

    __

    Why: The suggestion correctly identifies that using a hardcoded branch name master in the URL is not robust and proposes a relative path, which improves future maintainability.

    Low
    • More
    @sbryngelson sbryngelson merged commit 45d5302 into MFlowCode:master Jul 7, 2025
    18 checks passed
    @sbryngelson sbryngelson deleted the badge branch July 8, 2025 05:29
    prathi-wind pushed a commit to prathi-wind/MFC-prathi that referenced this pull request Jul 13, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    1 participant