-
Notifications
You must be signed in to change notification settings - Fork 332
Description
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