You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
One option for 5-9 is to simply provide instructions for how to trigger all the GitHub actions that perform all these activities for the user. Could also reference the implementations of those actions from the documentation for the definitive/working instructions vs duplicating the instructions in documentation which could get out of sync. It's even easier if the actions are set to run on all pushes, then a user can simply push a bundle branch to their fork and see that everything passes (or not).
Is your feature request related to a problem? Please describe.
Provide instructions to users on how to write high quality code.
Describe the solution you'd like
Complete the Writing High Quality Code section to add to the Contributing Guide.
Additional context
The draft so far:
Writing High-Quality Code
Follow cFS code conventions (formatting, symbol naming, file naming, etc) but do not change/reformat existing code except to address your changes.
For any new API's, add unit tests to cover nominal and off-nominal conditions.
Add/edit stubs to the unit test codebase for any new/modified functions.
For any changes to existing API's, alter the unit tests to cover the changes (and remove tests made irrelevant due to your changes).
Test your code, on a Linux platform (at minimum) --
TODO: Specific distros/versions/CPU architectures of Linux?
Build your code, including unit tests.
TODO: need "standard" build process.
Run the unit tests (all passed, yes?)
TODO: need "standard" test procedure.
Run the main cfs executable (no errors reported, yes?)
TODO: need "standard" test procedure, including targets.cmake recommendations.
?? Do we expect contributors to run coverage ?? Guessing no.
Requester Info
Ariel Adams, ASRC Federal
The text was updated successfully, but these errors were encountered: