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

Update Naming conventions for events and other patterns #2253

Closed
jphickey opened this issue Mar 9, 2023 · 0 comments · Fixed by #2254
Closed

Update Naming conventions for events and other patterns #2253

jphickey opened this issue Mar 9, 2023 · 0 comments · Fixed by #2254
Labels
docs This change only affects documentation. Equuleus-rc1
Milestone

Comments

@jphickey
Copy link
Contributor

jphickey commented Mar 9, 2023

Is your feature request related to a problem? Please describe.
As CFS apps are under development for the next cycle it should be a goal to reduce all the variation in terminology between them. This includes, but not limited to:

  1. Event naming patterns
  2. Command naming patterns (specifically between the function that handles the command, the structure that defines the command)

The first step in fixing pattern violations is to better define the intended pattern. This should be done as part of the CFE documentation and we can go from there.

Describe the solution you'd like
Consistency in naming, repeatable patterns.

Additional context
Examples of what NOT to do were recently addressed in nasa/FM#131, specifically stuff like:

Send HK command: command handler was FM_ReportHK(), the command struct name was FM_HousekeepingCmd, and the MID was FM_SEND_HK_MID. Why are these all different - Should all be FM_SendHkCmd (Camel Case version).

For FM_SET_FILE_PERM_CC the command handler was named FM_SetPermissionsCmd - no "file" - and the struct was named FM_SetPermCmd_t - "permissions" got abbreviated.

Other examples of abbreviation mismatch between Dir and Directory exist, and the word File/Files appears in command names in some places but not other places.

Similar naming chaos occurs in other CFS apps too, FM just provided some good examples of what not to do.

Requester Info
Joseph Hickey, Vantage Systems, Inc.

dzbaker added a commit that referenced this issue Apr 13, 2023
Fix #2253, update naming convention document
@dmknutsen dmknutsen added this to the Equuleus milestone May 26, 2023
@chillfig chillfig added the docs This change only affects documentation. label Aug 30, 2023
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. Equuleus-rc1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants