Create and manage commit templates
Commit templates define how changes are recorded in CellRepo.
They let you capture experimental updates in a structured, consistent way, instead of relying on free-text notes.
This section explains:
- how to create a commit template
- what fields are used for
- how templates can be updated over time
Where commit templates live
Commit templates exist independently of repositories.
Depending on how you use CellRepo:
- if you are working on your own, templates belong to your workspace
- if you are part of an organisation, templates can belong to the organisation
Templates can be reused across:
- multiple projects
- multiple repositories
This allows consistent documentation without duplicating setup.
Creating a commit template
To create a commit template:
- Open Commit templates from the navigation
- Click Create template
- Give the template a clear name
- Add fields that describe what should be recorded
- Save the template
Once created, the template becomes available when making commits.
You do not need to design the perfect template on day one.
Understanding template fields
Each commit template consists of fields.
A field represents one piece of information you want recorded when a change is made.
Examples include:
- description of the experimental step
- protocol or method used
- parameters or conditions
- observations or results
- notes or comments
- file or data attachments
Fields can be:
- structured (specific inputs)
- flexible (free text)
- optional or required
The goal is to capture meaningful, repeatable information, not to over-constrain the user.
Editing and evolving templates
Commit templates are designed to evolve.
You can:
- add new fields
- rename fields
- remove unused fields
- adjust which fields are required
Changes to a template:
- apply to future commits
- do not modify past commit history
This ensures historical records remain accurate and unchanged.
When to create multiple templates
You may want multiple templates when:
- different experiments require different documentation
- multiple teams work with different protocols
- one template becomes too broad or complex
For example:
- a “Routine experiment” template
- a “Major protocol change” template
- a “Validation or results” template
Templates help standardise documentation without forcing everything into one format.
What templates do not control
Commit templates:
- do not define permissions
- do not control repository visibility
- do not restrict who can commit
They only define what information is recorded when a commit is made.
What to do next
Once a commit template exists, you’re ready to create a repository and start recording work.
→ Create your first repository
→ Make your first commit
You can always return to templates later to refine them as your workflow matures.