Selbst Open und FAIR Code erstellen
Wenn Sie Code von Anfang an so anlegen, dass er für Sie und andere gut nutzbar ist, sparen Sie später Aufwand, etwa bei der Veröffentlichung oder nach einem Review. Ziel ist Code, der offen und FAIR ist: frei verwendbar und zugleich auffindbar, zugänglich, interoperabel und nachnutzbar. Die folgenden Punkte helfen Ihnen dabei.
Vor dem Start
- Entscheiden Sie sich möglichst für eine offene Programmiersprache, zum Beispiel Julia, Python oder R.
Im Code-Repositorium
- Verwalten Sie Ihren Code mit Versionskontrolle, etwa auf GitHub oder GitLab. Das macht Änderungen nachvollziehbar und erleichtert das gemeinsame Arbeiten.
- Machen Sie Ihren Code verständlich: mit einheitlichen Datei- und Ordnernamen (siehe Tipps), guter Lesbarkeit und Dokumentation und einer README-Datei.
- Lesen und speichern Sie Daten möglichst in offenen Standardformaten, etwa CSV statt .dta oder .xlsx.
- Halten Sie fest, welche Pakete und Programmversionen Ihr Code benötigt, zum Beispiel in einer renv.lock- oder requirements.txt-Datei. Bei komplexen Anforderungen kommt ein Code Notebook oder Container infrage.
- Wählen Sie eine offene Lizenz und legen Sie sie als LICENSE-Datei ab.
- Ergänzen Sie maschinenlesbare Metadaten in einer CITATION.cff- oder codemeta.json-Datei und nennen Sie alle Autor:innen mit ihrer ORCID.
Beim Veröffentlichen
- Erstellen Sie ein Release, also eine feste, versionierte Fassung Ihres Codes.
- Archivieren Sie das Release öffentlich in einem Repositorium wie Zenodo, das eine DOI vergibt. GitHub allein ist nicht dauerhaft. Mehr dazu unter Selbst Open Code veröffentlichen.
- Verknüpfen Sie Ihren Code mit den zugehörigen Daten und der Publikation, etwa über deren DOIs in der README-Datei.
