Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cFS style guide #394

Open
CDKnightNASA opened this issue Nov 5, 2019 · 5 comments
Open

cFS style guide #394

CDKnightNASA opened this issue Nov 5, 2019 · 5 comments
Assignees
Labels
docs This change only affects documentation. enhancement

Comments

@CDKnightNASA
Copy link
Contributor

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 CDKnightNASA changed the title coding style guide cFS style guide Nov 5, 2019
@CDKnightNASA
Copy link
Contributor Author

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

@CDKnightNASA
Copy link
Contributor Author

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
Copy link
Contributor

skliper commented Nov 5, 2019

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

@jphickey
Copy link
Contributor

jphickey commented Nov 5, 2019

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
Copy link
Contributor Author

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.

@CDKnightNASA CDKnightNASA self-assigned this Nov 13, 2019
@skliper skliper added the docs This change only affects documentation. label May 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation. enhancement
Projects
None yet
Development

No branches or pull requests

3 participants