Git, CFF citation files & Semantic Versioning
2023-10-20
Tell other users how your theory should be cited, what the current version is, and more meta-data:
cff-version: 1.2.0
title: 'AST: Action selection theory'
message: >-
If you refer to this theory, please cite it using the
metadata from this file. This theory has not been peer reviewed yet.
type: report
authors:
- given-names: Felix
family-names: Schönbrodt
email: felix.schoenbrodt@psy.lmu.de
orcid: 'https://orcid.org/0000-0002-8282-3910'
affiliation: Ludwig-Maximilians-Universität München
repository-code: 'https://github.com/nicebread/AST'
abstract: >-
A theoretical model that explains how a donkey solves the
approach-approach conflict of hunger and thirst when the
two sources are separated.
keywords:
- approach-approach conflict
- action selection
- motivation
license: CC-BY-4.0
version: 0.2.5
date-released: '2023-10-30'
The tool only knows “software” and “data set” as types. Create it with either of these, and then exchange the message
and type
fields with:
message: >-
If you refer to this theory, please cite it using the
metadata from this file.
type: report
.cff
file in the top level folder of your repository.message
field, e.g.:
2.1.0
: “The last peer-reviewed version was 1.0.4
”1.0.2
is published at doi …”isReviewedBy
annotation of an identifier.Version numbers have three numbers: MAJOR.MINOR.PATCH.
Increment the:
The numbers are plain integers! For example, after 9 comes 10:
0.9.0 → 0.10.0 → 0.11.0 → 1.0.0 → 1.1.0
0.1.0
1.0.0
git
: Create a tag or a release whenever a major or minor version is released:
0.1.0
0.1.1
0.2.0
0.3.0 → 0.4.0 → ... → 0.12.6
0.12.6 → 1.0.0
1.4.0
), we made a huge change that makes the product incompatible to version 1: 2.0.0
So what changes warrant what kind of version increments? For theories it makes sense to think in terms of predictions.
The version number is recorded in two places:
.cff
fileIs every commit a new version? That would be very tedious, especially if you are currently developing the theory and have frequent commits. We recommend:
developer
branch for ongoing development. It is not necessary to update the version number in each development step..cff
fileCHANGELOG.md
main
branchCHANGELOG.md
into the release notes..cff
file to include the new DOI
Formal modeling in psychology - Empirisches Praktikum, Ludwig-Maximilians-Universität München