Logo

Beitragen

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: Sie sollten mit grundlegenden Git-Befehlen wie Klonen, Branching, Committing und Pushing vertraut sein.
  • Hugo: Unsere Website verwendet Hugo. Laden Sie es von der Hugo-Website herunter und installieren Sie es.
  • Docker Compose: Sie benötigen Docker Compose, um das Projekt lokal auszuführen.

Schnellstart für erfahrene Entwickler*innen

  1. Repository klonen: https://gitlab.git.nrw/web/git-nrw
  2. Entwicklungsserver starten: docker compose up
  3. Einen Branch erstellen und Ihre Änderungen vornehmen
  4. Einen Merge Request auf GitLab erstellen

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:

  • main Branch: Der Hauptbranch enthält den produktionsreifen Code.
  • feature Branches: Verwendet für die Entwicklung neuer Funktionen.
  • bug Branches: Verwendet für die Behebung von Fehlern.
  • chore Branches: Verwendet für Routineaufgaben wie das Aktualisieren von Abhängigkeiten oder Dokumentation.
  • courses Branches: Speziell für die Erstellung oder Aktualisierung von Kursen verwendet (wie oben beschrieben).

Beispiele für Branch-Namen: feature/add-search-functionality, bug/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.

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

Torben Buck
Torben Buck
SW
Sven Wöhrle
GR
Gorka Ribera
TG
Thomas Gerlach
Maximiliano Lira Del Canto
Maximiliano Lira Del Canto
Lena Becker
Lena Becker
Tobias Krahe
Tobias Krahe
AA
Abdul Ahad

Unterstützung

Haben Sie Fragen oder stoßen Sie auf Probleme? Nutzen Sie gerne unser Kontaktformular . Wir helfen Ihnen gerne weiter!

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