Skip to content

Add instructions on new python formatting and linting#182

Merged
kanekosh merged 6 commits intomainfrom
ruffInstructions
Oct 7, 2025
Merged

Add instructions on new python formatting and linting#182
kanekosh merged 6 commits intomainfrom
ruffInstructions

Conversation

@A-CGray
Copy link
Copy Markdown
Member

@A-CGray A-CGray commented Sep 15, 2025

Purpose

Updates instructions on formatting and linting tools to match our new ruff/pre-commit checks (mdolab/.github#74)

Expected time until merged

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (non-backwards-compatible fix or feature)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Documentation update
  • Maintenance update
  • Other (please describe)

Testing

Checklist

  • I have run ruff check and ruff format to make sure the Python code adheres to PEP-8 and is consistently formatted
  • I have formatted the Fortran code with fprettify or C/C++ code with clang-format as applicable
  • I have run unit and regression tests which pass locally with my changes
  • I have added new tests that prove my fix is effective or that my feature works
  • I have added necessary documentation

@A-CGray A-CGray requested a review from a team as a code owner September 15, 2025 16:45
@A-CGray A-CGray requested a review from anilyil September 15, 2025 16:45
@A-CGray A-CGray mentioned this pull request Sep 15, 2025
13 tasks
@A-CGray A-CGray requested review from ewu63 and removed request for anilyil September 19, 2025 18:26
kanekosh
kanekosh previously approved these changes Oct 6, 2025
@A-CGray
Copy link
Copy Markdown
Member Author

A-CGray commented Oct 6, 2025

@ewu63 can you review this?

Comment thread machFramework/contribute.rst Outdated
@A-CGray A-CGray requested a review from kanekosh October 7, 2025 17:43
@kanekosh kanekosh merged commit 84ff258 into main Oct 7, 2025
7 checks passed
@kanekosh kanekosh deleted the ruffInstructions branch October 7, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants