search

nasa / fprime

F´ - A flight software and embedded systems framework
https://fprime.jpl.nasa.gov
Apache License 2.0
9.95k stars 1.28k forks source link

Add contributing tips #2704

Closed JohanBertrand closed 1 month ago

JohanBertrand commented 2 months ago
Related Issue(s)
Has Unit Tests (y/n) N/A
Documentation Included (y/n)

Change Description

I personally spent quite some time trying to figure out how to run tests properly on my computer, specially when fpp needed to be updated for the PR to pass.

I have added here my current workflow.

Rationale

It is currently hard to figure out how to run all tests for new contributors.

Testing/Review Recommendations

My workflow with modified versions of FPP might not be the best currently. Feel free to update it with the recommended workflow.

JohanBertrand commented 1 month ago

@LeStarch @thomas-bc is there anything else to be done in this MR?

LeStarch commented 1 month ago

PI tests are passing, but failing to upload artifacts. Will pass this!