Skip to content

Conversation

@sbryngelson
Copy link
Member

@sbryngelson sbryngelson commented Jul 7, 2025

User description

Adds a contributors guide. kind of basic but can improve later as needed.


PR Type

Documentation


Description

  • Add comprehensive contributing guide for MFC project

  • Include development workflow and coding standards

  • Provide setup instructions and testing guidelines

  • Document PR process and code review procedures


Changes diagram

flowchart LR
  A["Fork & Clone"] --> B["Setup Environment"]
  B --> C["Create Feature Branch"]
  C --> D["Code & Test"]
  D --> E["Format & Lint"]
  E --> F["Submit PR"]
  F --> G["Code Review"]
  G --> H["Merge"]
Loading

Changes walkthrough 📝

Relevant files
Documentation
CONTRIBUTING.md
Add comprehensive MFC contributing guide                                 

.github/CONTRIBUTING.md

  • Create comprehensive contributing guide with 6 main sections
  • Include development environment setup and workflow instructions
  • Document coding standards, Fypp metaprogramming, and testing
    guidelines
  • Provide PR preparation and code review process details
  • +113/-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.
  • @sbryngelson sbryngelson self-assigned this Jul 7, 2025
    Copilot AI review requested due to automatic review settings July 7, 2025 14:01
    @sbryngelson sbryngelson added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 7, 2025
    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 new CONTRIBUTING.md guide to help developers set up, follow project conventions, and submit PRs smoothly.

    • Describes environment setup and test/format commands
    • Defines branching, commit message, and CI management workflow
    • Documents Fortran style, Fypp usage, testing, GPU guidelines, PR preparation, and issue triage

    @qodo-merge-pro
    Copy link
    Contributor

    qodo-merge-pro bot commented Jul 7, 2025

    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
    ⚡ No major issues detected

    @qodo-merge-pro
    Copy link
    Contributor

    qodo-merge-pro bot commented Jul 7, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Use standard angle brackets

    The placeholder <your‑user> should use standard angle brackets instead of special Unicode
    characters. This ensures compatibility across all systems and follows common
    documentation conventions.

    .github/CONTRIBUTING.md [13]

    -git clone https://github.com/<your‑user>/MFC.git
    +git clone https://github.com/<your-user>/MFC.git
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion correctly identifies and fixes a non-standard hyphen in <your‑user>, which could cause copy-paste errors, although the summary and description are imprecisely worded.

    Low
    Use standard hyphen character

    The branch naming convention uses a Unicode hyphen character instead of a
    standard ASCII hyphen. This could cause issues with git commands and should use
    standard characters.

    .github/CONTRIBUTING.md [33]

    -| 2 | **Create a branch**: `git checkout -b feature/<short‑name>` | Keep each branch focused on one logical change. |
    +| 2 | **Create a branch**: `git checkout -b feature/<short-name>` | Keep each branch focused on one logical change. |
    Suggestion importance[1-10]: 5

    __

    Why: The suggestion correctly identifies and fixes a non-standard hyphen in <short‑name>, which could cause copy-paste errors for users trying to follow the branch creation command.

    Low
    • More

    @sbryngelson sbryngelson enabled auto-merge (squash) July 7, 2025 14:02
    @sbryngelson sbryngelson disabled auto-merge July 7, 2025 14:03
    @sbryngelson sbryngelson merged commit cbba358 into MFlowCode:master Jul 7, 2025
    18 checks passed
    @sbryngelson sbryngelson deleted the contributing 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

    Labels

    documentation Improvements or additions to documentation enhancement New feature or request Review effort 1/5

    Development

    Successfully merging this pull request may close these issues.

    1 participant