Logo

Beitragen

Beitragen zu git.nrw

Wir schätzen dein Interesse, zu git.nrw beizutragen! Diese Plattform ist ein Gemeinschaftsprojekt zwischen Universitäten in Nordrhein-Westfalen, das mit Hugo erstellt wurde und darauf ausgelegt ist, Bildungsressourcen für die Universitätsgemeinschaft bereitzustellen. Deine Beiträge sind entscheidend für die Erweiterung und Verbesserung dieser Plattform.

Dieser Leitfaden wird dir helfen zu verstehen, wie du beitragen kannst, insbesondere bei der Erstellung von Kursen, und sicherstellen, dass deine Beiträge nahtlos in das Projekt integriert werden.

Verhaltenskodex

Wir setzen uns für die Schaffung einer offenen und einladenden Umgebung ein. Bitte behandle jeden mit Respekt und Professionalität. Diskriminierung, Belästigung oder jegliche Form von unangemessenem Verhalten werden nicht toleriert.

Wie du beitragen kannst

Voraussetzungen

  • Git-Kenntnisse: Du solltest mit grundlegenden Git-Befehlen wie Klonen, Branching, Committing und Pushing vertraut sein.
  • Hugo: Unsere Website verwendet Hugo. Lade es von der Hugo-Website herunter und installiere es.
  • Docker Compose: Du benötigst Docker Compose, um das Projekt lokal auszuführen.

Schnellstart für erfahrene Entwickler

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

Für detaillierte Informationen zu Inhaltsrichtlinien, Lizenzierung und mehr, lies 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 Erstellung von Kursen ist innerhalb der Plattform selbst verfügbar. Diese Anleitung bietet umfassende Anweisungen zur Strukturierung deines Kurses, zum Schreiben effektiver Inhalte und zur Nutzung der verfügbaren Funktionen. Sie dient auch als reales Beispiel eines Kurses.

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: Erstelle Lektionsdateien in Abschnittsordnern, z.B. hugo new courses/<kebab-style-kursname>/10-getting-started/10-introduction.md
  5. Deinen Inhalt in Markdown schreiben.
  6. Kurs vorschauen: http://localhost:1313/de/courses/<kebab-style-kursname>
  7. Änderungen committen: git add ., git commit -m "Deine Nachricht", git push
  8. Merge Request auf GitLab erstellen.

Bilder und Medien

  • Speichere Bilder in static/images/courses/<kursname>/.
  • Lade Videos bei YouTube, Vimeo oder TIB AV-Portal hoch und verlinke sie im Frontmatter deines Kurses mit den entsprechenden Feldern (youtube, vimeo oder tibav). Beispiel: youtube: dQw4w9WgXcQ
  • Stelle sicher, dass du die Rechte oder Lizenzen zur Nutzung aller Medien hast.

Inhaltsrichtlinien

  • Sprache: Verwende klare und prägnante Sprache, vermeide Fachjargon oder erkläre ihn, wenn nötig.
  • Formatierung: Behalte die Konsistenz in der Markdown-Formatierung bei.
  • Dateinamen: Verwende Englisch, kebab-case und organisiere Lektionen in Abschnittsordnern mit numerischen Präfixen (z.B. 10-getting-started/10-introduction.md).
  • Metadaten: Fülle alle erforderlichen Felder im Frontmatter deiner Markdown-Dateien aus.

Lizenzierung

  • Deine Inhalte: Lizenziere deine Beiträge unter CC BY.
  • Inhalte Dritter: Verwende nur Inhalte mit angemessenen Lizenzen, gib die Lizenz deutlich an und halte dich 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

Wenn du Fragen hast oder auf Probleme stößt, zögere bitte nicht, unser Kontaktformular zu nutzen.

Vielen Dank für deine Beiträge und dafür, dass du Teil der git.nrw-Community bist!