Home

Workflow

-Devan to fill in sections below (add more as needed).

Unit Testing

Pull Requests

Code Standards

Naming Conventions

This should serve as a reference for whenever we are writing code/onboarding new people. Obviously there will be exceptions to any rule but in general we should really try to follow this.

Variables

Variables should be created in their respective init file (scParams_init.m for example) and they should follow the following naming convention:

descriptiveName_referenceFrame_units

so in total they should appear:

simParams.initFileName.descriptiveName_referenceFrame_units

where obviously there can be more subdivisions between the initFileName and the actual variable name.

Simulink

this is pretty simple just do camelCase for slx. For libraries make sure the file is called

simName_lib.slx

and in the actual sim the block (which should have open in an outs) should have the title

simName_lib

and should appear,

General stuff for files

• Folders can be capitalized (it helps seperate them out from files)

• All underscores (outside of variable) serve to describe what the file does, for example:

  • simName_test_init.m
  • simName_init.m