nasa/fprime
1
0
Fork 0
mirror of https://github.com/nasa/fprime.git synced 2025-12-10 00:44:37 -06:00
Code Issues Packages Projects Releases 34 Wiki Activity

Update UT guidelines in Contributing guide (#4421)

Browse Source 
* Add clang-tidy to requirement.txt, and update Unit Test guideline

* Leave out of requirements until rPI is supported or avoided

* Fix spelling of macOS

---------

Co-authored-by: djbyrne <djbyrne@jpl.nasa.gov>
This commit is contained in:
djbyrne17 2025-11-19 15:31:50 -08:00 committed by GitHub
parent 6d756f7431
commit 027b658208
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
CONTRIBUTING.md
View File

@ -37,7 +37,7 @@ development process, and helpful tips sections below.
## Code Contribution Process ## Code Contribution Process
All code contributions to F´ begin with an issue. Whether you’re fixing a bug, adding a feature, or improving documentation, please start by opening an issue describing your proposal. The Change Control Board (CCB) reviews and approves issues before work begins to ensure alignment with project goals and standards. Once approved, you can proceed with implementation and submit a pull request (PR). All code contributions to F´ begin with an issue. Whether you're fixing a bug, adding a feature, or improving documentation, please start by opening an issue describing your proposal. The Change Control Board (CCB) reviews and approves issues before work begins to ensure alignment with project goals and standards. Once approved, you can proceed with implementation and submit a pull request (PR).
If a PR is opened for work that does not correspond to an approved issue, the PR will be routed through the CCB process first—reviewed on a best-effort basis—and may be delayed or declined depending on CCB decisions.You can read more about how this process works in the [F´ Governance document](https://github.com/nasa/fprime/blob/devel/GOVERNANCE.md). If a PR is opened for work that does not correspond to an approved issue, the PR will be routed through the CCB process first—reviewed on a best-effort basis—and may be delayed or declined depending on CCB decisions.You can read more about how this process works in the [F´ Governance document](https://github.com/nasa/fprime/blob/devel/GOVERNANCE.md).
@ -160,25 +160,23 @@ pip install -Ur requirements.txt
# Initialize googletest submodule: # Initialize googletest submodule:
git submodule update --init --recursive git submodule update --init --recursive
# Run CI tests on fprime
./ci/tests/Framework.bash
# Run CI tests on the reference application
./ci/tests/Ref.bash
# Run the static analyzer with the basic configuration # Run the static analyzer with the basic configuration
# Purge unit test directory # Purge unit test directory
fprime-util purge fprime-util purge
# Generate the build files for clang-tidy. Make sure clang-tidy is installed. # Generate the build files for clang-tidy
fprime-util generate --ut -DCMAKE_CXX_CLANG_TIDY=clang-tidy-12 # On macOS, expect a CMake Warning 'Leak sanitizer is not supported on macOS in cmake/sanitizers.cmake'
fprime-util generate --ut -DCMAKE_CXX_CLANG_TIDY=clang-tidy
# Build fprime with the static analyzer # Build fprime with the static analyzer
fprime-util build --all --ut -j16 fprime-util build --all --ut -j16
# Run Unit Tests
fprime-util check --all
# Run the static analyzer with additional flight code checks # Run the static analyzer with additional flight code checks
# Purge release directory # Purge release directory
fprime-util purge fprime-util purge
# Generate the build files for clang-tidy. Make sure clang-tidy is installed. # Generate the build files for clang-tidy.
fprime-util generate -DCMAKE_CXX_CLANG_TIDY="clang-tidy-12;--config-file=$PWD/release.clang-tidy" fprime-util generate -DCMAKE_CXX_CLANG_TIDY="clang-tidy;--config-file=$PWD/release.clang-tidy
# Build fprime with the static analyzer # Build fprime with the static analyzer
fprime-util build --all -j16 fprime-util build --all -j16
``` ```