Code von Anfang an so zu entwickeln, dass er offen und gut nachnutzbar ist, kann später Aufwand sparen – beispielsweise bei der Veröffentlichung oder wenn andere Ihren Code weiterverwenden möchten. (Als Erinnerung: Open bedeutet nicht gleich FAIR und FAIR nicht gleich Open.) Die folgenden Empfehlungen zeigen Ihnen, worauf Sie bei der Erstellung von Open und FAIR Code achten sollten:

1. OPEN Code erstellen

Was Sie bei der Entwicklung beachten sollten:

- Eine offene Programmiersprache wählen: Entscheiden Sie sich möglichst für eine offene Programmiersprache, zum Beispiel Julia, Python oder R. Tipps und Ressourcen für den Einstieg in R finden Sie in diesem Blogbeitrag.

- Versionskontrolle nutzen: Verwalten Sie Ihren Code mit Versionskontrolle, etwa auf GitHub oder GitLab. So bleiben Änderungen nachvollziehbar und die Zusammenarbeit mit anderen wird erleichtert.

- Code verständlich organisieren: Verwenden Sie einheitliche und aussagekräftige Datei- und Ordnernamen (siehe Tipps zur Projektstruktur). Achten Sie außerdem auf lesbaren und gut dokumentierten Code und erstellen Sie eine README-Datei, die den Zweck und die Verwendung Ihres Codes erklärt.

- Offene Formate verwenden: Lesen und speichern Sie Daten möglichst in offenen Standardformaten, beispielsweise CSV statt proprietärer Formate wie .dta oder .xlsx.

- Abhängigkeiten dokumentieren: Halten Sie fest, welche Pakete und Programmversionen Ihr Code benötigt, beispielsweise in einer renv.lock- oder requirements.txt-Datei. Bei komplexeren Anforderungen können Sie ein Code Notebook oder eine containerbasierte Ausführungsumgebung verwenden.

Was Sie bei der Veröffentlichung beachten sollten:

- Eine offene Lizenz wählen: Wählen Sie eine passende offene Lizenz und hinterlegen Sie diese als LICENSE-Datei in Ihrem Repository. Die Lizenz legt fest, wie andere Ihren Code nutzen, verändern und weitergeben dürfen.

- Code öffentlich bereitstellen: Veröffentlichen Sie Ihren Code in einem öffentlich zugänglichen Repository, beispielsweise auf GitHub oder GitLab. Achten Sie darauf, keine vertraulichen Informationen oder personenbezogenen Daten offenzulegen.

Damit ist Ihr Code Open. Um ihn langfristig auffindbar, zitierbar und gut nachnutzbar zu machen, sollten Sie zusätzlich die FAIR-Prinzipien berücksichtigen:

2. Code FAIR machen

- Findable (auffindbar): Ergänzen Sie maschinenlesbare Metadaten, damit Ihr Code eindeutig beschrieben und gefunden werden kann. Verwenden Sie dafür beispielsweise eine CITATION.cff- oder codemeta.json-Datei. Geben Sie alle Autor:innen möglichst mit ihrer ORCID an.

- Accessible (zugänglich): Sorgen Sie dafür, dass Ihr Code über einen dauerhaften Verweis erreichbar bleibt. Veröffentlichen Sie dafür eine bestimmte Version Ihres Codes (Release) und archivieren Sie diese beispielsweise auf Zenodo. Dort erhalten Sie einen Digital Object Identifier (DOI), über den die jeweilige Version dauerhaft referenziert werden kann.

- Interoperable (interoperabel): Verwenden Sie möglichst offene, standardisierte Datenformate und vermeiden Sie proprietäre Abhängigkeiten. Orientieren Sie sich außerdem an etablierten Standards und Konventionen Ihrer wissenschaftlichen Fachgemeinschaft.

- Reusable (wiederverwendbar): Dokumentieren Sie Ihren Code so, dass andere ihn verstehen und einsetzen können. Geben Sie insbesondere Informationen zu benötigten Paketen, Programmversionen und Ausführungsbedingungen an. Stellen Sie außerdem sicher, dass Lizenz, Autor:innenschaft und Zitierinformationen eindeutig angegeben sind.

Praktische Unterstützung: In 11 Schritten zu FAIR Code

Die Checkliste „How to Make Your Code FAIR in 11 Steps“ führt Sie Schritt für Schritt zu FAIRem Code.