Commit 613542f4 authored by Axel Dürkop's avatar Axel Dürkop

Add Anleitung Contribution

parent 736e15ad
......@@ -85,4 +85,4 @@
## Meta
* [Impressum und Kontakt](meta/impressum.md)
* [Beitragen und Weiternutzen](meta/beitragen.md)
<!-- untoc -->
# Beitragen
<!-- toc orderedList:0 depthFrom:1 depthTo:6 -->
* [Szenarien für die Beteiligung an einem Projekt](#szenarien-für-die-beteiligung-an-einem-projekt)
* [Szenario für Einsteiger_innen](#szenario-für-einsteiger_innen)
* [Einen neuen Branch erstellen](#einen-neuen-branch-erstellen)
* [Szenario für Erfahrene](#szenario-für-erfahrene)
* [Das Repository forken](#das-repository-forken)
* [Inhalte bearbeiten](#inhalte-bearbeiten)
* [Merge Request (MR) stellen](#merge-request-mr-stellen)
* [Über den Beitrag diskutieren](#über-den-beitrag-diskutieren)
* [Referenzen](#referenzen)
<!-- tocstop -->
Dieses Werk ist lizenziert unter einer <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/legalcode.de">Creative Commons Namensnennung - Weitergabe unter gleichen Bedingungen 4.0 International Lizenz</a>. Jeder darf es bearbeiten, kopieren und unter Beachtung der Lizenzbedingungen für eigene Zwecke verwenden.
Der Quellcode dieses Skripts liegt auf der [Kollaborationsplattform der TU Hamburg](https://collaborating.tuhh.de/itbh/veranstaltungsskript-inf-sose2017). Dem [GitLab Flow](https://about.gitlab.com/2014/09/29/gitlab-flow/) wird gefolgt, um Beiträge und Änderungen zu begutachten und zu integrieren.
Das Skript wird mit der [freien Software GitBook](https://github.com/GitbookIO/gitbook) gebaut, die auch lokal installiert werden kann. GitBooks können auch online [mit dem gleichnamigen Service entwickelt werden](https://www.gitbook.com/).
Das Skript ist in [Markdown](https://www.gitbook.com/book/gitbookio/markdown/details) geschrieben.
Diskussion über die Inhalte des Skripts können im [Issue Tracker](https://collaborating.tuhh.de/itbh/veranstaltungsskript-inf-sose2017/issues) des GitLab-Repositorys geführt werden.
## Szenarien für die Beteiligung an einem Projekt
An dieser Stelle sollen zwei Szenarien skizziert werden, mit denen die Mitarbeit an diesem Skript möglich ist. Beide Möglichkeiten sind auch auf andere (Software)projekte übertragbar.
In jedem Fall ist für die Mitarbeit an diesem Skript folgendes notwendig:
* [ein GitLab-Account](https://collaborating.tuhh.de/users/sign_in)
* Für fortgeschrittene Arbeiten an dem Skript ist auch eine lokal installierte Version von [Git](https://git-scm.com/) notwendig, ggf. auch eine grafische Benutzeroberfläche.
### Szenario für Einsteiger_innen
***Beitragende sind in GitLab registriert und werden in das Projekt eingeladen. Dieser Weg ist für die OER-Projekte auf Basis von GitLab/GitBook an der TUHH zu empfehlen.***
#### Einen neuen Branch erstellen
Mitglieder dieses Projekts können jederzeit einen eigenen Branch erstellen, in dem sie dann bestehende Dateien verändern und auch neue erstellen können. Ein Branch wird als Kopie des [Masters](https://collaborating.tuhh.de/itbh/veranstaltungsskript-inf-sose2017/tree/master) erzeugt. Der Master ist die Version, aus der [das produktive Skript](https://fizban05.rz.tu-harburg.de/itbh/veranstaltungsskript-inf-sose2017/) erzeugt wird.
---
![Neuen Arbeitsbranch erstellen](/abb/beitragen-neuer-branch.png)
---
Auf der folgenden Seite wird der Branch sinnvoll benannt. Das kann der Name des Benutzers sein, aber auch eine stichwortartige Beschreibung des Vorhabens, das in dem Branch erledigt werden werden soll. **In diesem Workflow exisitieren Branches nicht lange.** Anschließend wird der Branch mit einem Klick auf *Create branch* erstellt.
---
![Den neuen Branch benennen](/abb/beitragen-branch-benennen.png)
---
Die folgende Seite zeigt den Verzeichnisbaum des neuen Branches. Hier kann auf alle beteiligten Dateien zugegriffen werden. Neue Dateien und Ordner können angelegt werden.
---
![Auswählen und Hinzufügen von Dateien und Ordner im neuen Arbeitsbranch](/abb/beitragen-dateien-auswaehlen.png)
---
Für beide Szenarien gilt, was unter [*Inhalte bearbeiten*](#inhalte-bearbeiten) beschrieben wird.
### Szenario für Erfahrene
***Interessierte forken das Repository, ändern und ergänzen in ihrer Kopie und stellen dann einen Merge Request an das Originalrepository. Die Schwierigkeit ergibt sich hier aus der Notwendigkeit, die eigene Kopie zu den Änderungen am Original aktuell zu halten. Dies ist nur über Git auf einem lokalen Rechner möglich und erhöht die Anforderungen.***
#### Das Repository forken
Forken Sie zuerst das [Repository](https://collaborating.tuhh.de/itbh/veranstaltungsskript-inf-sose2017) in ihren eigenen GitLab-Account.
---
![Das Repository forken im eingeloggten Zustand](/abb/beitragen-fork.png)
## Inhalte bearbeiten
Für die Bearbeitungen von Inhalten im Browser gilt bei beiden Szenarien das folgende:
---
![Dateien anzeigen, die zum Projekt gehören](/abb/beitragen-files.png)
---
**Vor der Bearbeitung muss darauf geachtet werden, dass der richtige Branch ausgewählt bzw. ein neuer erstellt wurde!**
Nun können die Dateien zur Bearbeitung ausgewählt werden.
---
![Datei zum Bearbeiten öffnen](/abb/beitragen-edit.png)
---
In dem Textfeld können Sie nun die Inhalte direkt bearbeiten.
---
![Schreiben im Textfeld](/abb/beitragen-bearbeiten.png)
---
Wenn die Bearbeitung abgeschlossen ist, speichern Sie mit dem Button *Commit Changes* am Ende der Seite.
---
![Speichern der Bearbeitung](/abb/beitragen-speichern.png)
---
### Merge Request (MR) stellen
Damit nun die Autor_innen des ursprünglichen Projekts an Ihren Veränderungen oder Verbesserungen teilhaben können, informieren Sie sie mit einem *Merge Request*.
---
![Seite für Merge Requests aufrufen (1), neuen MR erstellen (2)](/abb/beitragen-mr1.png)
![Quell- und Zielbranch auswählen](/abb/beitragen-mr2.png)
---
Auf der folgenden Seite kann noch eine Nachricht eingetragen werden. Der MR wird mit einem Klick auf *Submit merge request* abgeschlossen.
---
![Merge Request mit einem Kommentar versehen und abschließen](/abb/beitragen-mr-ende.png)
---
### Über den Beitrag diskutieren
Die Autor_innen des Originalprojektes erhalten nun eine Nachricht über den Beitrag und können ihn integrieren. Vorher haben sie aber die Möglichkeit, die Qualität des Beitrags zu beurteilen und ihn ggf. mit einem Kommentar zurückzuweisen. Dieses Verfahren sichert in hohem Maße die Qualität von Quellcode und Texten.
## Referenzen
* Diese Seite wurde in Anlehnung an [die Anleitung der Django Girls](https://github.com/DjangoGirls/tutorial/blob/master/README.md) erstellt.
* [Der GitLab Flow](https://docs.gitlab.com/ee/workflow/gitlab_flow.html#git-flow-and-its-problems). Einführung in die übliche Arbeitsweise mit Branches in GitLab
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment