From 63fa41dc5153c75b6b2c7747553d895653105d5e Mon Sep 17 00:00:00 2001 From: Nicole Dresselhaus Date: Tue, 27 May 2025 12:39:18 +0200 Subject: [PATCH] initial --- .gitlab/changelog_config.yml | 39 +++++ .gitlab/issue_templates/Bug.md | 26 +++ .gitlab/issue_templates/Decision Matrix.md | 27 ++++ .gitlab/issue_templates/Default.md | 3 + .gitlab/issue_templates/Deprecations.md | 125 ++++++++++++++ .gitlab/issue_templates/Documentation.md | 44 +++++ .gitlab/issue_templates/Experiment Idea.md | 41 +++++ .../Experiment Implementation.md | 25 +++ .../Feature Proposal - basic.md | 10 ++ .../Feature Proposal - lean.md | 17 ++ .../Feature proposal - detailed.md | 44 +++++ .gitlab/issue_templates/Implementation.md | 37 +++++ .gitlab/issue_templates/Refactoring.md | 25 +++ .gitlab/issue_templates/Release.md | 39 +++++ .gitlab/issue_templates/Review.md | 70 ++++++++ CHANGELOG.md | 11 ++ CITATION.md | 19 +++ CONTRIBUTING.md | 19 +++ INSTALL.md | 19 +++ README.md | 153 ++++++++++++++++++ data/.gitkeep | 0 raw/.gitkeep | 0 src/.gitkeep | 0 23 files changed, 793 insertions(+) create mode 100644 .gitlab/changelog_config.yml create mode 100644 .gitlab/issue_templates/Bug.md create mode 100644 .gitlab/issue_templates/Decision Matrix.md create mode 100644 .gitlab/issue_templates/Default.md create mode 100644 .gitlab/issue_templates/Deprecations.md create mode 100644 .gitlab/issue_templates/Documentation.md create mode 100644 .gitlab/issue_templates/Experiment Idea.md create mode 100644 .gitlab/issue_templates/Experiment Implementation.md create mode 100644 .gitlab/issue_templates/Feature Proposal - basic.md create mode 100644 .gitlab/issue_templates/Feature Proposal - lean.md create mode 100644 .gitlab/issue_templates/Feature proposal - detailed.md create mode 100644 .gitlab/issue_templates/Implementation.md create mode 100644 .gitlab/issue_templates/Refactoring.md create mode 100644 .gitlab/issue_templates/Release.md create mode 100644 .gitlab/issue_templates/Review.md create mode 100644 CHANGELOG.md create mode 100644 CITATION.md create mode 100644 CONTRIBUTING.md create mode 100644 INSTALL.md create mode 100644 README.md create mode 100644 data/.gitkeep create mode 100644 raw/.gitkeep create mode 100644 src/.gitkeep diff --git a/.gitlab/changelog_config.yml b/.gitlab/changelog_config.yml new file mode 100644 index 0000000..6fa342c --- /dev/null +++ b/.gitlab/changelog_config.yml @@ -0,0 +1,39 @@ +--- +# Settings for generating changelogs using the GitLab API. See +# https://docs.gitlab.com/ee/api/repositories.html#generate-changelog-data for +# more information. +categories: + added: Added + fixed: Fixed + changed: Changed + deprecated: Deprecated + removed: Removed + security: Security + performance: Performance + other: Other +include_groups: + - Methodenlabor +template: | + {% if categories %} + {% each categories %} + ### {{ title }} ({% if single_change %}1 change{% else %}{{ count }} changes{% end %}) + + {% each entries %} + - [{{ title }}]({{ commit.web_url }})\ + {% if author.credit %} by {{ author.reference }}{% end %}\ + {% if commit.trailers.MR %}\ + ([merge request]({{ commit.trailers.MR }}))\ + {% else %}\ + {% if merge_request %}\ + ([merge request]({{ merge_request.web_url }}))\ + {% end %}\ + {% end %}\ + + {% end %} + + {% end %} + {% else %} + No changes. + {% end %} +# The tag format for gitlab-org/gitlab is vX.Y.Z(-rcX). Releases are always without trailing -... +tag_regex: '^v(?P\d+)\.(?P\d+)\.(?P\d+)$' diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md new file mode 100644 index 0000000..1bcb68c --- /dev/null +++ b/.gitlab/issue_templates/Bug.md @@ -0,0 +1,26 @@ +### Summary + + + +### Steps to reproduce + + + +### What is the current _bug_ behavior? + + + +### What is the expected _correct_ behavior? + + + +### Relevant logs and/or screenshots + + + +### Possible fixes + + + +/label ~"type::bug" diff --git a/.gitlab/issue_templates/Decision Matrix.md b/.gitlab/issue_templates/Decision Matrix.md new file mode 100644 index 0000000..151df57 --- /dev/null +++ b/.gitlab/issue_templates/Decision Matrix.md @@ -0,0 +1,27 @@ + + +## Problem to solve + + + +## Decision Matrix + + + +| Acceptance criteria | Required | Option 1 | Option 2 | +| ------------------- | -------- | ---------------------------------- | ---------------------------------- | +| Criteria 1 | Yes/No | :white_check_mark:/:no_entry_sign: | :white_check_mark:/:no_entry_sign: | +| Criteria 2 | Yes/No | :white_check_mark:/:no_entry_sign: | :white_check_mark:/:no_entry_sign: | +| Criteria 3 | Yes/No | :white_check_mark:/:no_entry_sign: | :white_check_mark:/:no_entry_sign: | +| Criteria 4 | Yes/No | :white_check_mark:/:no_entry_sign: | :white_check_mark:/:no_entry_sign: | +| **Option Viable?** | - | Yes/No | Yes/No | + +## Decision due date + + + +## Final decision + + + +/label ~"group::" ~"section::" ~"Category:" diff --git a/.gitlab/issue_templates/Default.md b/.gitlab/issue_templates/Default.md new file mode 100644 index 0000000..5d7d07f --- /dev/null +++ b/.gitlab/issue_templates/Default.md @@ -0,0 +1,3 @@ +If you feel that your issue can be categorized as a reproducible bug or a +feature proposal, please use one of the issue templates provided and include as +much information as possible. diff --git a/.gitlab/issue_templates/Deprecations.md b/.gitlab/issue_templates/Deprecations.md new file mode 100644 index 0000000..a955f5f --- /dev/null +++ b/.gitlab/issue_templates/Deprecations.md @@ -0,0 +1,125 @@ + + +**A written process alone is unlikely to be sufficient to navigate through many +complexities. Please use this template as guidance with steps to take when +deprecating functionality, but not as an exhaustive list designed to generate +positive outcomes every time. Deprecations are often nuanced in their impact and +the approach needed may not be fully covered in this template.** + +--- + +### Deprecation Summary + +_Add a brief description of the feature or functionality that is deprecated. +Clearly state the potential impact of the deprecation to end users._ + +#### Documentation + +- Deprecation notice: [add link](here) +- Migration guidelines: [add link](here) +- etc. + +#### Reasons + +\_Describe why deprecation of this feature is necessary + +- [add links to the documentation](here) - i.e. Decision-Matrix, etc. + +### Breaking Change? + + + +Does this deprecation contain a breaking change? `Yes / No` + + + + + +### Affected Users + +Who is affected by this deprecation: GitLab.com users, Self-managed users, or +Dedicated users? (choose all that apply) + +- [ ] GitLab.com +- [ ] Self-managed +- [ ] Dedicated + +### Deprecation Milestone + +This deprecation will be announced in milestone: `xx.xx` _If this deprecation +has already been announced, include information about when the initial +announcement went out and what follow-up announcements are scheduled._ + +### Planned Removal Milestone + +The feature / functionality will be removed in milestone: `xx.xx` + +### Links + + + +### Checklists + +#### Timeline + +#### Communication Plan + +- DRI Product Manager: `@PM` + +An internal slack post and a release post are not sufficient notification for +our customers or internal stakeholders. Plan to communicate proactively and +directly with affected customers and the internal stakeholders supporting them. + +Internal Communication Plan + +- [ ] Internal announcement plan (timeline for notifications, audience, + channels, etc) + +External Communication Plan + +- [ ] User announcement plan (timeline for notifications, audience, channels, + etc) + - [ ] Documentation has been updated to mark the feature as `deprecated`. _Add + link to the relevant merge request._ +- [ ] On the major milestone: + - [ ] The deprecated item has been removed. _Add link to the relevant merge + request._ + - [ ] If the removal of the deprecated item is a + [breaking change](https://docs.gitlab.com/update/terminology/#breaking-change), + the merge request is labeled ~"breaking change". + - [ ] Document the migration plan for users, clearly outlining the actions + they need to take to mitigate the impact of the breaking change. + - [ ] [Add link](here) + +#### Labels + + + +/label ~group: ~"Category: + +- [ ] This issue is labeled ~deprecation, and with the relevant `~group::`, and + `~Category:` labels. +- [ ] This issue is labeled ~"breaking change" if the removal of the deprecated + item will be a + [breaking change](https://docs.gitlab.com/update/terminology/#breaking-change). + + + +/label ~"deprecation" diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md new file mode 100644 index 0000000..cef5ca7 --- /dev/null +++ b/.gitlab/issue_templates/Documentation.md @@ -0,0 +1,44 @@ + + +- [ ] Start this issue's title with `Docs:` or `Docs feedback:`. + +## Problem to solve + + + +## Further details + + + +## Proposal + + + +## Who can address the issue + + + +## Other links/references + + + +/label ~"documentation" /label ~"docs-only" + +/label ~"type::maintenance" ~"maintenance::refactor" + +/milestone %Backlog diff --git a/.gitlab/issue_templates/Experiment Idea.md b/.gitlab/issue_templates/Experiment Idea.md new file mode 100644 index 0000000..b229e8a --- /dev/null +++ b/.gitlab/issue_templates/Experiment Idea.md @@ -0,0 +1,41 @@ +## Experiment summary + +We believe that... {describe your hypothesis in one sentence} + +To verify that, we will... {describe your test in one sentence} + +And we’ll measure the impact on... {metrics} + +## Hypothesis + + + +## Supporting data + + + +## Expected outcome + + + +## Experiment design & implementation + + + +## Known assumptions + + + +## Results, lessons learned, next steps + + + +## Checklist + +- [ ] Fill in the experiment summary and write more about the details of the + experiment in the rest of the issue description. Some of these may be + filled in through time (the "Result, learnings, next steps" section for + example) but at least the experiment summary should be filled in right + from the start. + +/label ~"workflow::validation backlog" ~"experiment idea" diff --git a/.gitlab/issue_templates/Experiment Implementation.md b/.gitlab/issue_templates/Experiment Implementation.md new file mode 100644 index 0000000..988bdca --- /dev/null +++ b/.gitlab/issue_templates/Experiment Implementation.md @@ -0,0 +1,25 @@ + + +# Experiment Summary + + + +# Design + + + +# Control vs Candidate Experience + + + +| Control | Experiment | +| ------- | ---------- | +| | | + +# Tracking Details + + + +| activity | category | action | label | +| -------- | -------- | ------ | ----- | +| | | | | diff --git a/.gitlab/issue_templates/Feature Proposal - basic.md b/.gitlab/issue_templates/Feature Proposal - basic.md new file mode 100644 index 0000000..d474f5d --- /dev/null +++ b/.gitlab/issue_templates/Feature Proposal - basic.md @@ -0,0 +1,10 @@ + + +### Proposal + + + + + +/label ~Category: /label ~"type::feature" ~"feature::addition" ~documentation diff --git a/.gitlab/issue_templates/Feature Proposal - lean.md b/.gitlab/issue_templates/Feature Proposal - lean.md new file mode 100644 index 0000000..5ea5a1b --- /dev/null +++ b/.gitlab/issue_templates/Feature Proposal - lean.md @@ -0,0 +1,17 @@ + + +### Release notes + + + +### Problem to solve + + + +### Proposal + + + +/label ~"type::feature" diff --git a/.gitlab/issue_templates/Feature proposal - detailed.md b/.gitlab/issue_templates/Feature proposal - detailed.md new file mode 100644 index 0000000..a2fbd45 --- /dev/null +++ b/.gitlab/issue_templates/Feature proposal - detailed.md @@ -0,0 +1,44 @@ + + +### Release notes + + + +### Problem to solve + + + +### User experience goal + + + +### Proposal + + + +### Further details + + + +### Documentation + + + +### Impact + + + +### Links / references + +/label ~"type::feature" diff --git a/.gitlab/issue_templates/Implementation.md b/.gitlab/issue_templates/Implementation.md new file mode 100644 index 0000000..f11b1e7 --- /dev/null +++ b/.gitlab/issue_templates/Implementation.md @@ -0,0 +1,37 @@ + + +## Relevant links + + + +## Non-functional requirements + + + +- [ ] Documentation: + +## Verification steps + + + +/label ~"workflow::refinement" /milestone %Backlog diff --git a/.gitlab/issue_templates/Refactoring.md b/.gitlab/issue_templates/Refactoring.md new file mode 100644 index 0000000..762e91c --- /dev/null +++ b/.gitlab/issue_templates/Refactoring.md @@ -0,0 +1,25 @@ +## Summary + + + +## Improvements + + + +## Risks + + + +## Involved components + + + +/label ~"type::maintenance" diff --git a/.gitlab/issue_templates/Release.md b/.gitlab/issue_templates/Release.md new file mode 100644 index 0000000..de79860 --- /dev/null +++ b/.gitlab/issue_templates/Release.md @@ -0,0 +1,39 @@ + + +## Issues + + + +## Checklist + +- [ ] **Installation & Reproduzierbarkeit:** Sind alle Schritte, um die Daten + aus den Quelldaten erneut zu erstellen, dokumentiert (inkl. Dependencies, + evtl. mit Installationsbefehlen)? Ist ersichtlich, welche Umgebung nötig + ist (OS, Hardware)? +- [ ] **Grundlegende Nutzung:** Gibt es eine Anleitung oder Beispiele, wie man + die Daten verwendet (Daten -> Variablen in einer Programmiersprache)? Ist + mindestens ein typischer Workflow beschrieben, idealerweise mit + Beispielinput und -output? +- [ ] **Hintergrund & Referenzen:** Sind die wichtigsten Hintergründe oder + Referenzen über den Ursprung der Daten angegeben? Das muss kein Essay + sein, aber ein paar Sätze + Referenzen schaffen Vertrauen in die + wissenschaftliche Fundierung. +- [ ] **Kontakt & Weiterführung:** Ist angegeben, wie man Hilfe bekommt oder + Fehler melden kann (Issue-Tracker, E-Mail)? Gibt es Hinweise für Beiträge + (falls erwünscht) oder zumindest die Information, wer die Autor\*innen + sind? +- [ ] **Rechtliches & Zitation:** Liegt die Lizenz bei und wird sie genannt? + Sind Infos zum Zitieren der Software vorhanden (z. B. “Bitte zitieren Sie + DOI XYZ”)? Das stellt sicher, dass die Software nachnutzbar _und_ + akademisch kreditiert wird. +- [ ] **Aktualität & Version:** Entspricht die Dokumentation der aktuellen + Softwareversion? (Check: Versionsnummern, Datumsangaben). Veraltete Doku + kann schlimmer sein als keine – planen Sie also ein, die Doku mit jedem + Release kurz zu überprüfen. +- [ ] **Konsistenz & Stil:** Wird ein einheitlicher Ton und Stil durchgehalten? + (z. B. durchgehende Verwendung gleicher Begriffe für Konzepte, Sprache + entweder Deutsch oder Englisch einheitlich je nach Zielgruppe). Kleinliche + Fehler (Tippfehler, kaputte Links) sind auszumerzen, da sie Nutzer + abschrecken. + +/label ~"documentation::releases" diff --git a/.gitlab/issue_templates/Review.md b/.gitlab/issue_templates/Review.md new file mode 100644 index 0000000..2df1b4a --- /dev/null +++ b/.gitlab/issue_templates/Review.md @@ -0,0 +1,70 @@ + + +## 🎯 Review-Übersicht + +- **Reviewer:** @ +- **Datum:** YYYY-MM-DD +- **Review-Typ:** + - [ ] Code + - [ ] Dokumentation + - [ ] Allgemeines Feedback +- **Ziel / Scope:** Kurze Beschreibung des geprüften Inhalts + +--- + +## 📚 Kontext + +> Fasse zusammen, worum es geht, verlinke Ticket, Issue, Spezifikation, +> Live-Demo … + +--- + +## ✅ Was gut ist + +- [ ] Erfüllt die Anforderungen +- [ ] Sauber strukturierter Code / klare Dokumentation +- [ ] Verständliche Kommentare / Beispiele +- **Stärken:** + - Punkt 1 + - Punkt 2 + +--- + +## 🛠 Gefundene Probleme & Risiken + +- [ ] Fehler in Logik / Typos +- [ ] Fehlende Tests / unklare Schnittstellen +- [ ] Inkonsistente Benennung / Formatierung +- **Details:** + 1. Problem A – Ort, Fehlermeldung, Reproduktion + 2. Problem B – Ort, Auswirkung + +--- + +## 💡 Vorschläge & Empfehlungen + +- Kurze, konkrete Verbesserungsideen: + - ☑️ Refactor: … + - ☑️ Ergänze Tests für … + - ☑️ Dokumentiere / Beispiel hinzufügen für … +- Alternative Ansätze: + +--- + +## 🔍 Offene Fragen + +1. Ist der Use-Case X abgedeckt? +2. War die Performance unter Last geprüft? +3. Weitere Unklarheiten: … + +--- + +## 🚀 Nächste Schritte + +- [ ] Autor nimmt Änderungen vor +- [ ] Zweitrunde Review geplant für YYYY-MM-DD +- [ ] Tests / CI-Pipeline erfolgreich diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..df02561 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,11 @@ +# Changelog + +Dokumentation der Änderungen pro Version: + +## [v1.0.0] – 2025-05-08 + +- Erste stabile Version + +## [v0.1.0] – 2025-03-15 + +- Erstes öffentliches Release diff --git a/CITATION.md b/CITATION.md new file mode 100644 index 0000000..98c8254 --- /dev/null +++ b/CITATION.md @@ -0,0 +1,19 @@ +# Wie wird die Software zitiert? + +Nenne hier die bevorzugte Zitierweise für Publikationen oder DOI: + +```markdown +Nachname, Vorname. (Jahr). Projektname (Version X.Y.Z). DOI oder URL. +``` + +```bibtex +@software{bibtex-key, + author = {{}}, + title = {Projektname}, + url = {Projekthomepage}, + version = {version}, + date = {datum versions-release}, +} +``` + +- **Keine langen Beschreibungen**, nur den Zitierhinweis. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5ac46d6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# Wie beiträgt man zum Projekt? + +Anleitung zur Mitarbeit am Projekt. + +## Bugs melden & Vorschläge + +Wie meldet man Fehler oder schlägt Features vor? + +Vorbereitet ist der Gebrauch des GitLab-Issue-Trackers zusammen mit +entsprechenden Templates, die Dinge erleichtern. + +## Code beisteuern + +Richtlinien für Codequalität und Beiträge: + +- Wie erstelle ich einen Pull Request? +- Gibt es Stilrichtlinien (z.B. PEP8 für Python)? + +- **Nicht überkomplizieren**, sondern klaren Workflow beschreiben. diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..a3277b2 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,19 @@ +--- +date: 2025-05-14 # when was this touched last? +--- + +# Installation + +Ausführliche Schritt-für-Schritt Anleitung zur Installation von Dependencies und +Replikation der Daten. + +## Voraussetzungen + +Hier alle Abhängigkeiten (z.B. Python-Version, Pakete, externe Tools) listen. + +## Schritte zur Installation + +Detaillierte Installationsanweisungen (Code-Blöcke, Terminal-Befehle). + +- **Nicht ausführlich Grundlagen erklären**, stattdessen verlinken auf externe + Ressourcen. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5fea3a2 --- /dev/null +++ b/README.md @@ -0,0 +1,153 @@ +--- +title: "" +description: | + Kurze Beschreibung (2-3 Sätze), was für Daten hier liegen. +lang: de +date: 2025-01-01 +status: "initial planning..." +authors: + - name: Your Name + affiliation: + - name: Your Institution + url: Institutions homepage + email: your@email.here + orcid: 0000-0000-0000-0000 + roles: # CRediT-Roles - see https://credit.niso.org/ + - Conceptualization + - Supervision + - Validation + # ... weitere Autor*innen +--- + +Auf Wunsch Beschreibung noch einmal wiederholen + +## Über dieses Repository + +### Ziel / Zweck + +Kurz das Ziel oder den Bedarf für diese Daten erläutern. +(Beispiel: „Dieser Datensatz besteht aus … und eignet sich als Benchmark um die +Performance der Named Entity Recognition zu testen.“) + +Sind die Daten Final? Werden sie noch gesammelt? Wann wird mit Abschluss +gerechnet? + +### Reproduktion + +Kurz und präzise beschreiben, wie aus den Quelldaten der aktuelle Datensatz +erstellt wurde - also wie beiliegender Code und Scripte ausgeführt werden +müssen. + +- Verweise ggf. auf ausführliche [INSTALL.md](INSTALL.md) + +> [!warning] +> +> **Keine ausführliche Erklärung** von Standard-Tools (z.B. Python +> installieren), sondern verlinken auf offizielle Seiten + +### Nutzung / Bekannte Einschränkungen + +- Wann sollte ich den Datensatz nutzen? +- Wann sollte ich den Datensatz **nicht** nutzen? +- Welche **Biases** gibt es in den Daten? + +### Struktur + +```plain +Übersicht der Struktur z.b. generiert mittels +`tree -L2` oder `tree -L2 -d` +und anschließend überarbeitet +``` + +Ein Beispiel könnte sein: + +```plain +. +├── raw/ # raw data +├── src/ # code to process raw/ into data/ +├── data/ # processed data +├── CHANGELOG.md +├── CITATION.md # how to cite +├── CONTRIBUTING.md +├── INSTALL.md # instructions to reproduce +└── README.md # this file +``` + +- Kurze Beschreibung - entweder direkt im Tree oder hier in Prosa +- Ziel: Überblick über "Wo finde ich was". Wo ist Code? Wo ist ...? + +> [!warning] +> +> **Keine Details**, die über 1 Satz pro Element hinaus gehen. Bei detailliertem +> Bedarf `README.md` im jeweiligen Verzeichnis. + +## Meta-Informationen + +### Verantwortlichkeiten + +- Wer ist letztendlich verantwortlich für den Inhalt? +- Wer genehmigt/weist Inhalte ab? + +### Wissenschaftlicher Hintergrund + +Kurze Erklärung der wissenschaftlichen Grundlage (Methode, theoretischer Ansatz) +und Referenzen auf Publikationen oder Quellen. + +> [!warning] +> +> **Keine ausführliche Theorie**, diese gehört in Paper oder eigene Datei +> ([BACKGROUND.md](BACKGROUND.md)) + +### Lizenz & Zitation + +Kurz auf Lizenz verweisen (z.B. „siehe LICENSE“) und erklären, wie das Projekt +zu zitieren ist (z.B. DOI oder Verweis auf [CITATION.md](CITATION.md)). + +--- + +## Empfohlene Dokumentations-Dateien + +| **Dokuelement** | **Inhalt/Purpose** | **Format/Ort** | **Umfang** | +| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------- | +| **README (Hauptdoku)** | Zweck der Software; Kurzbeschreibung; Installationsanleitung; einfaches Nutzungsbeispiel; Lizenz- und Kontaktinfo | Markdown im Root des Repos (statisch versioniert) | 1–2 Seiten | +| **Wissenschaftlicher Hintergrund** | Erläuterung der Methode, Theorie, Algorithmen; Verweise auf Literatur | README-Abschnitt "Hintergrund" oder separate Doku (BACKGROUND.md) | 0.5–1 Seite (plus Referenzen) | +| **Bekannte Limitationen** | Auflistung von Einschränkungen, Annahmen, bekannten Problemen; ggf. Workarounds | README-Abschnitt "Limitations" oder FAQ.md | 0.5 Seite | +| **Beispiel-Workflow (Tutorial)** | Schritt-für-Schritt Anleitung mit einem realistischen Anwendungsfall (ggf. mit Code und Screenshot) | Jupyter Notebook (`.ipynb`) im Repo `examples/` Ordner oder Markdown in docs/ | 1–3 Seiten / entsprechend Zellen | +| **CONTRIBUTING** | Anleitung für Beitragswillige: Code Style, Workflow, Tests, Kontakt | CONTRIBUTING.md im Repo | 0.5–1 Seite | +| **LICENSE** / **CITATION** | Rechtliche Infos (Lizenztext); Zitationsleitfaden (Bevorzugte Zitierweise, DOI) | Jeweils eigene Datei im Repo (Plain Text/Markdown) | Kurz (Standardtext bzw. Referenz) | +| **Release-Information** | Versionshinweise, Änderungsprotokoll (Changelog) | CHANGELOG.md oder Releases auf GitHub | fortlaufend pro Version (Stichpunkte) | + +## Checklist + +Es ist eine gute Idee die sich ändernden Punkte in ein Release-Template zu +kopieren. + +- [ ] **Installation & Reproduzierbarkeit:** Sind alle Schritte, um die Daten + aus den Quelldaten erneut zu erstellen, dokumentiert (inkl. Dependencies, + evtl. mit Installationsbefehlen)? Ist ersichtlich, welche Umgebung nötig + ist (OS, Hardware)? +- [ ] **Grundlegende Nutzung:** Gibt es eine Anleitung oder Beispiele, wie man + die Daten verwendet (Daten -> Variablen in einer Programmiersprache)? Ist + mindestens ein typischer Workflow beschrieben, idealerweise mit + Beispielinput und -output? +- [ ] **Hintergrund & Referenzen:** Sind die wichtigsten Hintergründe oder + Referenzen über den Ursprung der Daten angegeben? Das muss kein Essay + sein, aber ein paar Sätze + Referenzen schaffen Vertrauen in die + wissenschaftliche Fundierung. +- [ ] **Kontakt & Weiterführung:** Ist angegeben, wie man Hilfe bekommt oder + Fehler melden kann (Issue-Tracker, E-Mail)? Gibt es Hinweise für Beiträge + (falls erwünscht) oder zumindest die Information, wer die Autor\*innen + sind? +- [ ] **Rechtliches & Zitation:** Liegt die Lizenz bei und wird sie genannt? + Sind Infos zum Zitieren der Software vorhanden (z. B. “Bitte zitieren Sie + DOI XYZ”)? Das stellt sicher, dass die Software nachnutzbar _und_ + akademisch kreditiert wird. +- [ ] **Aktualität & Version:** Entspricht die Dokumentation der aktuellen + Softwareversion? (Check: Versionsnummern, Datumsangaben). Veraltete Doku + kann schlimmer sein als keine – planen Sie also ein, die Doku mit jedem + Release kurz zu überprüfen. +- [ ] **Konsistenz & Stil:** Wird ein einheitlicher Ton und Stil durchgehalten? + (z. B. durchgehende Verwendung gleicher Begriffe für Konzepte, Sprache + entweder Deutsch oder Englisch einheitlich je nach Zielgruppe). Kleinliche + Fehler (Tippfehler, kaputte Links) sind auszumerzen, da sie Nutzer + abschrecken. diff --git a/data/.gitkeep b/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/raw/.gitkeep b/raw/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 index 0000000..e69de29