search

nasa / cFE

The Core Flight System (cFS) Core Flight Executive (cFE)
Apache License 2.0
402 stars 199 forks source link

cFS style guide #394

Open CDKnightNASA opened 4 years ago

CDKnightNASA commented 4 years ago

Is your feature request related to a problem? Please describe. Code and file naming in cFS and apps is inconsistent and does not follow a particular set of guidance, and no guidance were developed previously for cFS.

Describe the solution you'd like Develop a "Style Guide" in markdown format for inclusion in cFE/docs, describing code formatting conventions, symbol naming conventions, documentation conventions, directory structure and file naming conventions, etc. This should be referenced by the App Developer's guide and any other relevant docs and may incorporate or replace parts of existing documents. Perhaps also link/refer from the github wiki.

Describe alternatives you've considered Other options include adding style information to the app developer's guide or identifier naming conventions documents.

Additional context Jake provided the GSFC "indent" flags that are standard at GSFC, this is a good starting point for formatting and should be documented.

Requester Info Chris Knight, NASA Ames Research Center

CDKnightNASA commented 4 years ago

Should this be a ticket in the cFS github site and should docs be moved "up" into the cFS repository?

CDKnightNASA commented 4 years ago

Joe: In particular, I'd like to see a mention of NOT using type suffixes (u/l) on literals. Been "bitten" by this numerous times. (as in #335)

skliper commented 4 years ago

I suggest suffixes on literals also get documented in the deployment/configuration guide.

jphickey commented 4 years ago

I think all documentation should remain with CFE. The "cFS" repo is just a test bundle; it shouldn't provide anything that cannot be gotten via the submodules.

CDKnightNASA commented 4 years ago

clang-format seems like a better option, as a number of editors (vim, emacs, bbedit, ...) can be integrated with the configuration file used by clang-format.