Naming Conventions - GTAC-MGI/GTAC-ESP-LIMS GitHub Wiki
Git Branching
Branch naming:
gtac/feat-###
gtac/bugfix-###
gtac/release-###
where ###
is the number on the corresponding ticket on the kanban board.
Branch and merge new release branches off of:
gtac/main
Branch and merge feat and bug branches off of release branches.
ESP Protocols & Workflows
Protocols and Workflows in the ESP UI should be named in the following format:
LABNAME Lab: Protocol / Wf Name Like This
For example:
- SEQ Lab: Create Illumina Library
- RNA Lab: Process QC Data
- CLE Lab: Accession New Samples
When creating new yaml files for workflows and protocols, or exporting from the Production server, filenames should use the following format:
labname_protocol_or_wf_name_like_this_type.yml
For example:
- seq_create_illumina_library_workflow.yml
- rna_process_qc_data_protocol.yml
- cle_accession_new_samples_protocol.yml
wf.export(f"wfs/{wf.name.lower().replace(' lab:', '').replace(' ', '_')}_workflow.yml", deep=False)
pt.export(f"pts/{pt.name.lower().replace(' lab:', '').replace(' ', '_')}_protocol.yml", deep=False)