Entwicklung

Für neue Entwickler hier ein Quickstart Guide: https://github.com/mediathekview/MediathekView/wiki/Quickstart-Guide

Um den Code für die Zukunft wartbar zu halten und Bugs zu minimieren sollte der Code so sauber wie nötig geschrieben werden. Hierzu empfhielt sich z.B. folgende Lektüre: https://www.bbv.ch/images/bbv/pdf/downloads/V2_Clean_Code_V3.pdf (archivierte Version)

Voraussetzungen

• Java 15 JDK
• git
• git-flow (optional; eine Toolsammlung für vereinfachtes Arbeiten mit Git Flow, siehe Workflow)
• maven

Code auschecken

mkdir mediathekview
cd mediathekview
git clone https://github.com/mediathekview/MediathekView.git
cd MediathekView

Workflow

Wir setzten Git Flow als Workflow ein. Wir empfehlen die dazugehörigen Tools zu verwenden. Es ist aber auch möglich mit reinem Git zu arbeiten.

• mit Tools (empfohlen)
• ohne Tools

Weitergehender Allgemeiner git-Workflow

• Entwickeln: Regelmäßig, am besten nach jedem baufähigen Commit, pushen. git push
• Wenn die Entwicklung fertig ist nochmal pushen und dann Pull Request erstellen. Dann ggf. nötige Änderungen einbauen und nach erfolgreichem Merge den Branch löschen. Entweder via GitHub oder mit git:

# Löscht den Branch "branchname", (bspw. "feature/#112") lokal, aber nur wenn breits gemerged wurde.
git branch -d [branchname]
# Löscht den Branch bei GitHub, der ":" ist wichtig.
git push origin :[branchname] 

Allgemeiner GitHub Hinweis

Issues können automatisch durch Keywords bei Commits auf master geschlossen werden: Closing issues via commit messages

Bauen und starten an der Kommandozeile

cd MediathekView
mvn clean install
cd target
java —-enable-preview -jar MediathekView.jar

alternativ, ohne installiertes maven:

cd MediathekView
./mvnw clean install
cd target
java —-enable-preview -jar MediathekView.jar

Entwicklung mit Eclipse

• Projekt MediathekView als Maven-Projekt importieren.