Variable naming guideline

[diitaz93]

To standardise the development process in cg, we should agree on some naming conventions for variables of certain types. The following table is a draft for the conventions and below is a discussion forum to decide on them. The last column determines the status of the discussion. When a decision has been made, it will be reflected in the coding guidelines Atlas page. Once a naming convention is agreed upon, all developers are expected to follow it. The developers can name variables under their criteria if no agreed naming convention exists for a variable type.

Variable type	Name or suffix	Example	Decision
Application	application	application = Application(...)	under discussion
ApplicationVersion	application_version	application_version = application.version	under discussion
Analysis	analysis	analysis = Analysis(...)
Family	case	case = Family(...)	agreed
Flowcell	flow_cell	flow_cell = Flowcell(...)
Sample	sample	sample = Sample(...)
database id	_entry_id	sample_entry_id: int = sample.id
cg id	_id	sample_id: int = sample.internal_id
FlowCellDirectoryData	flow_cell	flow_cell = FlowCellDirectoryData(...)	under discussion
Path	_path	flow_cell_path = Path(...)
str representing a path	_dir	flow_cell_dir: str = "/home/proj/..."