Skip to content

Commit

In CellRepo, a commit is how you record a meaningful state of a biological asset.

If you think in lab terms, a commit is similar to: - writing a dated entry in a lab notebook - marking an experimental checkpoint - saving a snapshot of what exists at a specific moment

Commits are the foundation of traceability in CellRepo.


What a commit represents

A commit represents the state of one repository at a specific point in time.

It captures: - what the asset looks like right now - when this state was recorded - who recorded it - optional context explaining why it matters

A commit does not mean the work is finished.
It simply means: this state is worth recording.


How commits fit into CellRepo

A simple way to think about the structure:

  • Project → groups related work
  • Repository → tracks one biological asset
  • Commit → records change over time

Projects provide context.
Repositories represent assets.
Commits record evolution.

(If this hierarchy is unclear, see
Project and Repository.)


When should you make a commit?

You should make a commit whenever something about the asset changes in a way that matters.

Common examples include: - initial construction of a strain or construct - confirmation of genotype or sequence - modification of a plasmid design - completion of a key experimental step - measurement results that influence next decisions

You do not need to commit every small action.
Think in terms of meaningful checkpoints, not raw activity.


A realistic example

Organisation: NovaSyn Bio Lab
Project: Lactate production optimisation in E. coli
Repository: ΔldhA knockout strain (E. coli MG1655)

Example commits in this repository might be: - “Initial construction of ΔldhA knockout strain” - “Genotype confirmed by Sanger sequencing” - “Growth rate measured under aerobic conditions” - “Strain archived after completion of optimisation phase”

Together, these commits tell a clear story of how the strain evolved.


What information goes into a commit

A commit can include: - a short description of the change - files (e.g. sequences, images, protocols) - notes or observations - links to external data or records

You can add as much or as little detail as is appropriate at the time.

Incomplete information is acceptable.
Future commits can always add more context.


Commit messages

Each commit has a commit message, which briefly explains what changed and why.

Good commit messages are: - specific - descriptive - understandable months or years later

Good examples: - “Updated plasmid design to strengthen promoter region” - “Confirmed genotype after sequencing analysis”

Avoid vague messages like: - “Update” - “Fix” - “Final version”

Clear messages make histories genuinely useful.

(If your team prefers structured messages, see
Commit templates.)


What happens if something goes wrong?

If you realise a mistake was made: - you do not delete history - you create a new commit that corrects or updates the record

This preserves transparency and traceability.

CellRepo is designed to show how work evolved, not to hide missteps.


Commit history and traceability

A repository’s commit history allows you to: - understand how an asset evolved - identify decision points - demonstrate provenance and ownership - support collaboration, audits, and IP discussions

This history is one of the key reasons CellRepo exists.


If commits feel unfamiliar

If the idea of committing feels new or uncomfortable, that’s completely normal.

Most users find that: - commits quickly become intuitive - recording checkpoints improves clarity - histories become valuable sooner than expected

You do not need to be “perfect” with commits for them to be useful.


Getting help

If you’re unsure what should count as a commit, or how detailed commits should be for your work, you don’t need to guess.

You can contact us at
📧 support@cellrepo.com

We’re happy to help translate CellRepo concepts into your specific lab workflow.