Logo

Beitragen

Gestalten Sie eine offene Plattform für Hochschulen in NRW mit.

Zum Repository Zur Anleitung
Auf dieser Seite

Beitragen zu git.nrw

Wir freuen uns über Ihr Interesse, an git.nrw mitzuwirken! Diese Plattform ist ein Gemeinschaftsprojekt von Hochschulen in Nordrhein-Westfalen. Sie basiert auf Hugo und stellt freie Bildungsressourcen (OER) für die Hochschulgemeinschaft bereit. Ihre Beiträge sind essenziell für den Ausbau und die Verbesserung dieses Angebots.

Dieser Leitfaden unterstützt Sie dabei, sich in das Projekt einzubringen – insbesondere bei der Erstellung von Kursen. Er soll sicherstellen, dass Ihre Beiträge reibungslos integriert werden können.

Verhaltenskodex

Wir setzen uns für ein offenes und freundliches Miteinander ein. Bitte begegnen Sie allen Beteiligten mit Respekt und Professionalität. Diskriminierung, Belästigung oder unangemessenes Verhalten jeglicher Art tolerieren wir nicht.

Wie Sie beitragen können

Voraussetzungen

Git-Kenntnisse

Vertraut mit den Grundlagen: Klonen, Branching, Committing und Pushing.

Hugo

Unsere Website basiert auf Hugo. Hier installieren.

Docker Compose

Wird benötigt, um das Projekt lokal auszuführen.

Schnellstart für erfahrene Entwickler*innen

1

Repository forken auf gitlab.git.nrw/web/git-nrw und Ihren Fork klonen

2

Entwicklungsserver starten — docker compose up

3

Einen Branch erstellen (z. B. feat/… oder fix/…) und Ihre Änderungen vornehmen

4

Einen Merge Request nach stage erstellen und Bearbeitung durch Maintainer erlauben

Für detaillierte Informationen zu Inhaltsrichtlinien, Lizenzierung und mehr, lesen Sie bitte weiter unten.

Branching-Strategie

Wir folgen einer klaren Branching-Strategie, um Beiträge effektiv zu verwalten:

Branch Zweck
main Die produktive Live-Website
stage Staging — Änderungen werden zunächst hierher gemergt und geprüft
feat/* Entwicklung neuer Funktionen
fix/* Behebung von Fehlern
chore/* Routineaufgaben wie Abhängigkeiten oder Dokumentation
courses/* Erstellung oder Aktualisierung von Kursen

Änderungen werden zuerst nach stage gemergt und nach der Prüfung auf main (die Live-Website) übernommen.

Beispiele für Branch-Namen: feat/add-search-functionality, fix/login-error, courses/add-git-basics-course

Einen Kurs erstellen

Eine detaillierte Anleitung zur Kurserstellung finden Sie direkt auf der Plattform . Dort erfahren Sie, wie Sie Ihren Kurs strukturieren, verständliche Inhalte verfassen und die technischen Funktionen optimal nutzen. Diese Anleitung dient gleichzeitig als Beispielkurs.

Kurzbeschreibung

  1. Repository klonen: git clone https://gitlab.git.nrw/web/git-nrw.git
  2. Entwicklungsserver starten: docker compose up
  3. Neuen Kurs erstellen: hugo new courses/<kebab-style-kursname>/_index.md
  4. Lektionen hinzufügen: Erstellen Sie Lektionsdateien in Abschnittsordnern, z.B. hugo new courses/<kebab-style-kursname>/10-getting-started/10-introduction.md
  5. Ihren Inhalt in Markdown schreiben.
  6. Kurs vorschauen: http://localhost:1313/de/courses/<kebab-style-kursname>
  7. Änderungen committen: git add ., git commit -m "Ihre Nachricht", git push
  8. Merge Request auf GitLab erstellen.

Bilder und Medien

  • Speichern Sie Bilder in static/images/courses/<kursname>/.
  • Laden Sie Videos bei YouTube, Vimeo oder TIB AV-Portal hoch und verlinken Sie sie im Frontmatter Ihres Kurses mit den entsprechenden Feldern (youtube, vimeo oder tibav). Beispiel: youtube: dQw4w9WgXcQ
  • Stellen Sie sicher, dass Sie die Rechte oder Lizenzen zur Nutzung aller Medien haben.

Inhaltsrichtlinien

  • Sprache: Verwenden Sie eine klare und prägnante Sprache. Vermeiden Sie unnötigen Fachjargon oder erklären Sie Begriffe, wo nötig.
  • Formatierung: Behalten Sie die Konsistenz in der Markdown-Formatierung bei.
  • Dateinamen: Verwenden Sie Englisch, kebab-case und organisieren Sie Lektionen in Abschnittsordnern mit numerischen Präfixen (z.B. 10-getting-started/10-introduction.md).
  • Metadaten: Füllen Sie alle erforderlichen Felder im Frontmatter Ihrer Markdown-Dateien aus.

Mehrsprachige Inhalte

Die Website ist zweisprachig (Deutsch und Englisch). Bei Merge Requests werden automatische Validierungen durchgeführt:

  • Dateiendung: Alle Content-Dateien müssen die .md Endung haben.
  • Dateinamen: Deutsche und englische Versionen müssen identische Dateinamen haben.
  • Frontmatter: Bei News-Artikeln muss das Frontmatter übereinstimmen (außer title und Incident-Felder).

Beispiel korrekte Struktur:

content/
├── de/news/2026-01-20-mein-artikel.md
└── en/news/2026-01-20-mein-artikel.md   # Gleicher Dateiname!

Inhalt ohne Übersetzung: Wenn ein Inhalt (noch) nicht in beiden Sprachen verfügbar ist, fügen Sie translation: pending zum Frontmatter hinzu:

---
title: "Mein nur auf Deutsch verfügbarer Kurs"
translation: pending
---

Sobald die Übersetzung erstellt wurde, entfernen Sie das Feld wieder.

Lizenzierung

  • Ihre Inhalte: Lizenzieren Sie Ihre Beiträge unter CC BY.
  • Inhalte Dritter: Verwenden Sie nur Inhalte mit angemessenen Lizenzen, geben Sie die Lizenz deutlich an und halten Sie sich an deren Bedingungen. Kurse selbst müssen unter CC BY lizenziert sein.

Mitwirkende

Die git.nrw-Website entsteht offen und gemeinschaftlich. Danke an alle, die dazu beigetragen haben.

Maintainer dieser Website

Sven Wöhrle
Torben Buck

Mit Beiträgen von

Abdul Ahad
Lena Becker
Thomas Gerlach
Jelena Gonsior
Tobias Krahe
Maximiliano Lira Del Canto
Martin Pieters
Gorka Ribera
Christian Schild
Selbst mitwirken

Unterstützung

Fragen oder nicht weiter?

Unser Team hilft Ihnen jederzeit gerne weiter.

Support kontaktieren

Vielen Dank für Ihre Unterstützung und dass Sie Teil der git.nrw-Community sind!