Sourcecodeverwaltung

Aus OctoAwesome Wiki
Wechseln zu: Navigation, Suche

Diese Anleitung beschreibt das Herunterladen der aktuellen Entwicklungsversion von OctoAwesome und das Kompilieren dieser und ist auch an Neu- und Wiedereinsteiger gerichtet, die ihre ersten Schritte mit OctoAwesome machen.

Herunterladen: Git oder HTTP?

Das Projekt wird auf GitHub gehosted. Git ist ein Versionsverwaltungssystem und hilft enorm dabei, mit mehreren Mitgliedern verteilt am Code zu arbeiten. Um kontinuierlich auf dem aktuellen Stand zu bleiben oder am Projekt mitzuarbeiten, empfiehlt sich daher die Verwendung von Git. Alle, die das Projekt nur einmal ausprobieren wollen, sollten stattdessen aber besser die aktuelle ZIP-Datei verwenden.

Das Projekt wird in mehreren Branches (=Entwicklungszweigen) verwaltet:

  • master: Der Hauptbranch, die Applikation läuft stabil. Der master-Branch ist aber sehr viele Folgen hinter dem aktuellen Entwicklungsstand.
  • develop: Der aktuelle Entwicklungsstand: Möglicherweise nicht ganz stabil oder mit kleineren Fehlern. Für alle, die das Projekt in einem recht stabilen Stand testen wollen.
  • feature/*: Aktueller Entwiklungsstand bestimmter Features. Diese werden in eigenen Branches entwickelt und irgendwann in den develop-Branch zurück germerged. Normalerweise wird in den Folgen nur an Faeature-Branches gearbeitet.
  • archive/*: Alte Branches, die noch zur Referenz aufgehoben werden.

Über git clone https://github.com/OctoAwesome/octoawesome kann man sich den aktuellen Stand des Projektes herunterladen. Falls erünscht, kann man mit Hilfe von git checkout develop den aktuellen, instabilen Entwicklungsstand laden.

ZIP-Dateien herunterladen: Alternativ kann man auf GitHub den Code der einzelnen Branches als ZIP-Datei herunterladen. Dazu links unter der grünen Leiste den gewünschten Branch auswählen und dann nach einem Klick auf den grünen Button Clone or Download die Option Dowload ZIP anwählen.

Kompilieren

Die folgende Anleitung beschreibt nur das Kompilieren des develop-Branches!

Nach dem Herunterladen ist das Kompilieren der nächste Schritt. OctoAwesome lässt sich derzeit auf Windows und Linux kompilieren und verwendet dafür das plattformunabhängige Framework Engenious.

Windows

Zum Kompilieren des Projekts benötigt man ein installiertes VisualStudio.

  1. Per Doppelklick die Projektmappendatei (OctoAwesome.sln) öffnen.
  2. Die gesamte Projektmappe neu erstellen. Dazu Rechtsmausklick auf die Projektmappe im Projektmappenexplorer und dort den entsprechenden Eintrag auswählen.
  3. Das Projekt Octoawesome.Client per Rechtsmausklick > Als Startprojekt festlegen.
  4. Das Projekt mit F5 starten.

Linux

Unter Linux kann man das Projekt auch mit Hilfe von MonoDevelop kompilieren.

Mitmachen: Pull Requests

Wenn du mitmachen willst, kannst du auf GitHub das Projekt forken und einen Pull Request mit deinen Änderungen erstellen. Bitte sei aber sparsam mit den Pull Requests; diese widersprechen eigentlich dem Sinn eines Let's Codes. Wenn doch, dann halte dich bitte an folgende einfache Regeln:

  • Pull Requests sollten immer aus dem develop-Branch abgeleitet werden und in diesen zurückmergen. Nur in wenigen Ausnahmen bietet sich die Ableitung von einem feature-Branch an!
  • Bitte keine zu großen Änderungen ohne Absprache mit Tom. Änderungen an bestehenden oder Einführung neuer Konzepte gehen in der Regel nicht direkt! Kleine Änderungen werden aber immer gerne gesehen (z.B. Bugfixes, Übersetzungen, Verbesserungen am User Interface oder kleinere Features).

Diese Regelen sollen aber niemenden vom Mitmachen abhalten, denn nur wenn ein Let's Code zum Lernen und Mitmachen anregt, erfüllt es sein Ziel!