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
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
The text was updated successfully, but these errors were encountered:
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.
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.
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
The text was updated successfully, but these errors were encountered: