Am Projekt teilnehmen

Vorbereitung

1. In GitHub einloggen / Einen GitHub Account erstellen.
2. Auswahl und Installation eins Git Clients (z.B. Git Desktop oder Git Kraken)
3. Auswahl einer Entwicklungsumgebung:
   • Arduino IDE - einfache übersichtliche Software, mit allen benötigten Funktionen
   • Eclipse C/C++ + Sloeber Plugin (in Eclipse->Help->Eclipse Marketplace-> suchen nach "Arduino" oder "Sloeber" und installieren). Eclipse gibt es nur auf englisch und es ist komplizierter zu konfigurieren. Es besitzt aber dafür eine Autovervollständigung und weiter Komfortfunktionen.
4. Klonen oder Forken dieses Repositories über den Git Client. Für Eclipse sollte es in einem Pfad ohne Leerzeichen befinden.
5. Projekt öffnen
   1. Arduino IDE: Es kann einfach die .ino geöffnet und bearbeitet werden.
   2. Eclipse: Nach dem Starten, dem Festlegen eines Workspaces und dem Installieren des Plugins, kann man unter "File-Import->General->Existing Projects into Workspace" den Pfad des Repositories angeben und das Projekt importieren.

Ein einfacher Arbeitsablauf.

Zu Beginn erstellt man mit 'git branch [name]' einen neuen Zweig mit dem namen [name] (natürlich ohne Klammern.) Evlt. geht es je nach Git Client auch einfacher. Nun stellt man sicher dass der Zweig ausgecheckt ist. Nachdem alles soweit vorbereitet ist kann man nun ganz normal mit dem Arbeiten beginnen. Mit einem Git Commit kann man seinen Änderungen lokal eintragen und mit Git Push wird der Zweig mitsamt allen Änderungen in das Online Repository geladen. Wenn man nach evtl. sogar mehreren Sitzungen mit dem aktuellen Problem fertig ist, kann man eine Merge Request (Anfrage zum Zusammenlegen) stellen. Daraufhin wird der Versuch gestartet die Änderung in den Hautpfad(master) zu integrieren.

Bei kleineren Änderungen kann man natürlich auch gleich auf dem master Zweig arbeiten.

Mehr Informationen zum Arbeiten mit Git gibt es zum Beispiel hier.

Regeln zum Arbeiten

• Geschriebener Code sollte kommentiert und ausreichend lesbar formatiert(Arduino IDE = strg+T, Eclipse = strg+umschlat+F) sein.
• Größere Änderungen sollten auf einem extra Git-Zweig stattfinden und später gemerget werden.
• Der Code muss immer von beiden IDE's kompilierbar sein. Dies sollte regelmäßig geprüft werden.
• Klassen sollten nur in der obersten Ebene (also dem Ordner in der die .ino liegt) erstellt werden.

Bibliotheken einbinden

Eclipse

Einige standart Bibliotheken sind unter "Arduino-> Add libary to selected Project" vorhanden.

Nicht vorhandene und benutzte Bibliotheken sollten im Ordner "libaries" abgelegt werden. Für Eclipsenutzer muss eine Referenze für den Compiler angelegt werden: Arduino->Add source folder to selected Project->Bibliotheksordner auswählen oder [alternativ].(https://stackoverflow.com/questions/29051576/how-do-i-add-arduino-libraries-to-eclipse-project).

Probleme/Issues

Falls Probleme auftreten oder Hilfe benötigt wird, kann man unter dem Tab "Issues" ein neues Issue mit Name, Beschreibung und Problemtyp (s. Labels) erstellt werden.