Skip to content

[nasa/nos3#550] code formatter #568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Mar 27, 2025
Merged

[nasa/nos3#550] code formatter #568

merged 12 commits into from
Mar 27, 2025

Conversation

dacarter22
Copy link
Contributor

Added linter.yml file into the .github/workflows/linter.yml directory for every component submodule and merged all into dev

@dacarter22 dacarter22 closed this Mar 25, 2025
@dacarter22 dacarter22 reopened this Mar 25, 2025
@codecov-commenter
Copy link

codecov-commenter commented Mar 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.82%. Comparing base (1b52bab) to head (26ce97c).
Report is 57 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #568      +/-   ##
==========================================
+ Coverage   72.77%   72.82%   +0.05%     
==========================================
  Files         744      745       +1     
  Lines       91191    91497     +306     
  Branches     6923     6942      +19     
==========================================
+ Hits        66362    66636     +274     
- Misses      24829    24861      +32     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rjbrown2
Copy link
Member

rjbrown2 commented Mar 25, 2025

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

New Feature Submissions:

  • Does your submission pass tests?
    • Freshly provisioned VM via Vagrant
      • Default pathing
    • Direct clone into environment.
  • No changes to ./cfg/nos3-mission.xml
  • Confirm the following:
    • Flight Software loaded and running successfully
    • Spacecraft in 42 GUI points at sun and telemetry reports SVB (sun vector in body frame) X gets to a value of 1, others 0
  • Submodules Updated:
    • Submodule paths correct
    • Submodules merged appropriately into submodule dev branches, or Pull requests created and completed PRIOR to this request.

      Submodules have been modified to perform auto clang formatting.

Changes to Core Features:

  • Explanation added as to what your changes do and why they should be included

    Added Linter workflow, and clang rules from cFS to each sub module for auto formatting.

How to test these changes?

  • Explanation provided below detailing steps to test and validate changes

    There is no major testing needed to validate these changes. Other than verifying that the auto-format has been performed within the sub modules. (It Has)

Closing Tags

  • Add any closing tags, or manually set this PR to close any related issue(s) that this PR resolves.
    closes Code Formatter #550

@rjbrown2 rjbrown2 self-assigned this Mar 25, 2025
@rjbrown2 rjbrown2 added the Configuration Configuration label Mar 25, 2025
@rjbrown2 rjbrown2 linked an issue Mar 25, 2025 that may be closed by this pull request
@rjbrown2
Copy link
Member

The auto-commit of a linter will cause the "Checks Passed" portion of the PR to fall off if there are linter changes that are automatically changed.

We've decided that this trade-off is worth it for the automated linting.

Users can still click the workflow circles next to their commits to view these checks, rather than them showing up automatically.

@jlucas9 jlucas9 changed the title Nos3#550 code formatter [nasa/nos3#550] code formatter Mar 26, 2025
@jlucas9
Copy link
Contributor

jlucas9 commented Mar 26, 2025

Not a big deal for this work, but reminder that merge into dev for each submodule should happen after a PR like this is resolved.

Copy link
Contributor

@jlucas9 jlucas9 left a comment

Choose a reason for hiding this comment

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

As submodules were already merged into dev those pieces were integrated already while closing prior merge requests.

Copy link
Collaborator

@zlynch2 zlynch2 left a comment

Choose a reason for hiding this comment

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

Approving, tested nos things look ok

# Conflicts:
#	components/arducam
#	components/generic_adcs
#	components/generic_css
#	components/generic_eps
#	components/generic_imu
#	components/generic_mag
#	components/generic_radio
#	components/generic_star_tracker
#	components/generic_thruster
#	components/generic_torquer
#	components/novatel_oem615
#	components/sample
@jlucas9
Copy link
Contributor

jlucas9 commented Mar 27, 2025

Manually confirmed sun pointing and sample CPT passed.

image

@jlucas9 jlucas9 merged commit 5fa97df into dev Mar 27, 2025
3 checks passed
@jlucas9 jlucas9 deleted the nos3#550-code-formatter branch March 27, 2025 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Configuration Configuration
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Code Formatter
5 participants