Opencaching-Wiki - Benutzerbeiträge [de]

Entwicklung

2020-05-05T18:29:47Z

Teiling88:

''Diese Seite wendet sich vor allem an Technikinteressierte und verwendet daher eine Menge Fachbegriffe, deren Erläuterung hier zu weit führen würde. Sie sind daher mit Links zur Wikipedia hinterlegt.''
----

[[Datei:Codegenerationen.svg|thumb|[[Opencaching]]-Codehistorie (Stand Juni 2016)]]
Hinter der Opencaching-Website verbergen sich eine Menge Technik und Entwicklungsarbeit. Was im Jahr 2003 als ein kleines Bastelprojekt begann, wuchs im Laufe der Jahre zu einer der weltweit bedeutendesten [[Geocaching-Plattformen]] heran.

Die aktuelle Opencaching.de-Softwareversion 3.0 besteht aus rund 70.000 Zeilen an selbstgeschriebenem [[wikipedia:PHP|PHP]]-, [[wikipedia:Smarty|Smarty]]-, [[wikipedia:Hypertext Markup Language|HTML]]/[[wikipedia:Cascading Style Sheets|CSS]]-, [[wikipedia:JavaScript|Javascript]]- und [[wikipedia:MySQL|MySQL]]-Code. Hinzu kommen ca. 20.000 Zeilen für die [[OKAPI]] und weitere 200.000 Zeilen [[wikipedia:Programmbibliothek|Bibliothekscode]]. Die [[wikipedia:Datenbank|Datenbank]] umfasst ca. 125 Tabellen plus 15 für die OKAPI.

Der Opencaching-Quellcode steht unter einer [https://github.com/OpencachingDeutschland/oc-server3/blob/development/doc/GPL.txt modifizierten GNU-GPL-Lizenz] und ist [https://github.com/OpencachingDeutschland/oc-server3 frei verfügbar]. Erläuterungen dazu gibt es im Artikel [[Entwicklung/Codedoku]].

Eine vollständige Versionsgeschichte der 3.0er OC-Software gibt es [http://changelog.oconly.de hier].
__NOTOC__
== Entwicklerteam ==
Mit der Gründung des [[Opencaching Deutschland e.V.]] ging die Weiterentwicklung auf ein neues Team über. Die aktiven Softwareentwickler sind in der [http://www.opencaching.de/articles.php?page=team Teamliste] aufgeführt. Neue engagierte Entwickler sind jederzeit willkommen! Wenn du im Team mitmachen möchtest, findest du weitere Informationen dazu im [http://forum.opencaching.de/index.php?board=33.0 Opencaching-Forum].

== Entwicklungsumgebung ==
[[Datei:Tux.png|thumb|hochkant=0.75]]
Für die Entwickler steht eine virtuelle Linux-Maschine als [[wikipedia:VirtualBox|VirtualBox]]-Image zur Verfügung, die wie die Opencaching.de-Website auf [[wikipedia:CentOS|CentOS]] basiert (→ [[Entwicklung/Entwicklersystem|Entwicklersystem]]). In dieser VM laufen ein [[wikipedia:Apache HTTP Server|Apache]]- und ein [[wikipedia:MySQL|MySQL]]-Server. Das eigentliche Programmieren und Testen findet auf dem Hostsystem unter Linux, Windows oder MacOS statt, mit einem beliebigen [[wikipedia:UTF-8|UTF-8]]-fähigen Editor bzw. einer PHP-[[wikipedia:Integrierte Entwicklungsumgebung|IDE]] und einem Webbrowser.

Zur Codeverwaltung und -versionierung wird [[wikipedia:Git|Git]] eingesetzt, mit einem üblichen Workflow (Stable-Branch, Entwicklungs-Branch, Test-Branch und Feature-Branches). Eine ausführliche Anleitung dazu gibt es [[Entwicklung/Git|hier im Wiki]].

Anstehenden Aufgaben werden in einer [[Entwicklung/Todo-Liste|Todo-Liste]] verwaltet.

Allgemeine Diskussionen finden im [http://forum.opencaching.de/index.php?board=43.0 offenen Entwicklerforum] statt. Im internen Team-Wiki gibt es Anleitungen zu Installation und Verwendung der Entwicklungsumgebung; diese sollen nach Neuaufsetzen der Entwicklungsumgebung hier ins allgemeine Wiki übertragen werden.

== Datenschnittstellen für Tool- und App-Entwickler ==
Über die [[Opencaching-API]] (OKAPI) oder die [[XML-Schnittstelle]] können alle Cache- und Logdaten frei heruntergeladen werden. Die OKAPI kann auch [[Das Onlinelog|Logs]] hochladen, sodass auch [[Smartphone-Apps für Opencaching.de|Smartphone-Apps]] mit [[Fachjargon#Field Logging|Field-Logging]]-Funktion realisierbar sind.

== Weitere Opencaching-Entwicklungsprojekte ==
* [http://code.google.com/p/opencaching-pl/ Opencaching Polen]
* [http://code.google.com/p/opencaching-api/ Opencaching-API]

[[Kategorie:Entwicklung| ]]

Opencaching-Wiki:Aktuelle Ereignisse

2018-10-26T19:16:39Z

Teiling88: /* Das Opencaching-Blog */

=== Das Opencaching-Blog ===

<rss max=4 item-max-length="100" date="(d.m.Y H:i:s)">https://blog.opencaching.de/feed/</rss>
'''[https://blog.opencaching.de/ weitere Meldungen]'''

=== Die neuesten Wiki-Seiten ===

{{Special:Newestpages/-/20}}

[[Kategorie:Metaseiten]]

Wie finde ich meinen ersten Cache?

2017-03-23T08:28:41Z

Teiling88: /* Einen Geocache auf das Navigationsgerät übertragen */Linus -> Linux

Erste Schritte auf Opencaching.de

Um einen Cache auf Openaching.de zu suchen, muss man sich '''nicht''' [[Registrierung|registrieren]]!

== Einen Cache aus dem Internet heraussuchen ==

=== Variante 1: Das [[Suchformular]] ===
'''Von der [http://www.opencaching.de/index.php?id=63 Opencaching Startseite] aus den Button ''Caches'' klicken.'''

Dieser öffnet die Auswahl an Parametern nach denen gesucht wird. Dort muss zunächst eine Auswahl getroffen werden, welche Geocaches gewünscht werden. Für den Anfang eignen sich am besten zunächst Caches des Typs [[Cachearten|normaler Geocache]] in den [[Behältergrößen|Größen]] Klein oder Normal, mit [[Schwierigkeitswertung|Schwierigkeits-]] und [[Geländewertung]] 1–2.
Als nächster Schritt wird dann die Gegend gewählt, in der sich der Geocache befinden soll.
Diese bestimmt man zu Beginn am besten über die Postleitzahl oder den Ortsnamen. Hierzu muss in der obersten Reihe bei Ausgabe sortieren nach: Entfernung angehakt sein.

Ist dies eingegeben, musst du nur noch den dahinter liegenden Button Suchen anklicken, und schon wird die Liste der nächstgelegenen Caches in aufsteigender Entfernung angezeigt. Von hier aus können die einzelnen Geocaches angeklickt und näher angeschaut werden.

Rechts oben in der Cachebeschreibung (auch ''Listing'' genannt) befindet sich eine kleine Karte. Klickt man einen der Links darunter an, öffnet sich eine größere Karte, auf der du erkennen kannst, in welcher Umgebung der Cache liegt. Dort findest du auch weitere Caches in der Nähe.

=== Variante 2: Die Karte ===
'''Von der [http://www.opencaching.de/index.php?id=63 Opencaching Startseite] aus den Button ''Karte'' klicken.'''

Es öffnet sich eine [[Cachekarte|Kartenansicht]], auf der Geocaches als Symbole eingezeichnet sind. Die Karte kann, wie z. B. von Google Maps gewohnt, mit der Maus bedient werden (verschieben, zoomen durch das Mausrad, usw.); zusätzlich kann man im Suchfeld nach Orten suchen.
Klickt man eines der Geocachesymbole auf der Karte an, öffnet sich ein Popupfenster mit den wichtigsten Informationen zum betreffenden Geocache; mit einem Klick auf den Namen des Geocaches gelangt man direkt zur vollständigen Cachebeschreibung.

Fortgeschrittene Nutzer können Filter benutzen um nur bestimmte Geocaches auf der Karte anzuzeigen; die Filtereinstellungen befinden sich direkt unterhalb der Kartenansicht. Möchte man beispielsweise nur Geocaches angezeigt bekommen, die einen Behälter haben, in den auf jeden Fall [[Tauschgegenstände]] passen, entfernt man aus der Liste "CACHE BEHÄLTER" alle Häkchen bis auf diejenigen bei ''klein'', ''normal'', ''groß'' und ''extrem groß''.

== Einen Geocache auf das Navigationsgerät übertragen ==
[[Datei:Cache-Download als GPX.jpg|thumb|rechts|Dropdown-Menu zum GPX-Download im Listing]]
[[Datei:Cache-Download als GPX auf der Karte.jpg|thumb|rechts|Download-Button auf der Karte]]
Ist ein bestimmter Geocache ausgewählt, geht es wie folgt weiter:

[[GPS-Gerät]] per USB-Kabel mit dem PC verbinden und warten bis der PC dieses erkannt hat. Nun wird das Listing des Wegpunktes als [[GPX-Datei]] heruntergeladen und im entsprechenden Verzeichnis des GPS-Geräts gespeichert (bei Garmin-Geräten ist das überlicherweise X:/Garmin/GPX ).

Bei Geräten, die keine GPX-Dateien verarbeiten können (z.B. auch ältere Garmin-Geräte), müssen die Wegpunkte über die entsprechender Herstellersoftware, oder freier Software wie dem [[OpenCacheManager]] (für Linux), auf das GPS-Gerät kopiert werden.

Der Button "an GPS-Gerät senden" wird auf Opencaching.de nicht mehr verwendet, da das zugehörige Browser-PlugIn von Garmin nicht mehr unterstützt wird.

Möchte man gleich mehrere Caches einer Region downloaden kann man auf der Karte den GPX-Button verwenden. Damit werden alle Caches, die sich auf der Karte befinden auf einmal als GPX-Datei heruntergeladen.

Ist der Geocache fertig übertragen, kann das Gerät abgestöpselt werden und der Outdoorteil kann beginnen. '''Für den Anfang empfiehlt es sich immer, das Listing noch auszudrucken und mitzunehmen.'''

Kleiner Tip: Viele Geocaches haben sog. [[Hinweise|verschlüsselte Hinweise]]. Diese kann man, wenn man sie nutzen möchte (für Anfänger auf jeden Fall empfohlen) vor dem Ausdruck entschlüsseln, indem man in der Cachebeschreibung auf '''Entschlüsseln''' klickt.

== Der Outdoorteil ==
Ist der Geoache auf das Gerät überspielt, kann der Outdoorteil beginnen.

Zunächst auf dem [[GPS-Gerät]] den zu suchenden Geoache auswählen. Dies funktioniert bei jedem Gerät anders, Bedienungsanleitung beachten. Meist gibt es eine Funktion Suche. In dieser „Geocaches“ auswählen und den gewünschten Geocache anwählen. Los drücken und ab auf die Suche.

Viele Geräte haben ein Kompassfeld, in dem man dann die Annäherung an das Ziel in einem der Datenfelder anzeigen lassen und ablesen kann.
Zeigt dieses null Meter an, steht man nicht automatisch vor dem Geocache, auch wenn das schön wäre. Es gibt immer gewisse Abweichungen in den Koordinaten durch [[GPS#Genauigkeit|Schwankungen der Empfangsqualität]] zu rechnen – 5–10 Meter Abweichung sind normal, aber auch 20 Meter kommen vor. Daher ist vorsichtiges Suchen angesagt, wenn man vor Ort angekommen ist. Hier kann der entschlüsselte Hinweis eine weitere Unterstützung sein. Bitte stets vorsichtig suchen, die [[Naturschutz|Natur]] wird es dir danken. Wenn andere Leute (nach Harry Potter „Muggels“ benannt) in der Nähe sind, besser erst mal warten bis diese verschwunden sind und dann suchen. Nicht jeder hat Verständnis für unser Hobby. Werden Verstecke durch unvorsichtiges Suchen verrraten, kommt es nicht selten vor, dass sie ausgeraubt („gemuggelt“) werden.

== Dose gefunden – und was jetzt? ==
'''Erst mal herzlichen Glückwunsch, Du hast deinen ersten Geocache gefunden!'''

In der Dose befindet sich immer mindestens das [[Logbuch]]. In diesem verewigt man sich mit dem Usernamen, den man sich bei der [[Registrierung]] zugelegt hat, Datum und evtl. Uhrzeit. Befinden sich [[Tauschgegenstände]] in der Dose, kann nach Belieben etwas getauscht werden (besonders beliebt bei Kindern), dabei aber bitte immer '''gleichwertig, oder höherwertig''' tauschen. Nichts ist so frustrierend, gerade für Kinder, wie eine Dose voll Schrott.
Es können sich auch sog. [[Reisende]] in der Dose befinden. Diese können ohne Tausch mitgenommen werden, um sie zu einem anderen Geocache reisen zu lassen. Bitte aber '''nur dann''' Reisende mitnehmen, wenn man sie auch wirklich ordnungsgemäß [[log]]gen will.

Ist dies alles abgeschlossen, wird die Dose wieder versteckt, wie sie vorgefunden wurde. Die Tarnung darf natürlich leicht verbessert werden falls die Dose schlecht getarnt war, aber '''''keinesfalls''''' soll eine Dose [[Fachjargon#umverstecken|an einer anderen Stelle versteckt]] werden, auch wenn eine andere Stelle geeigneter erscheint. '''Einzige Ausnahme:''' Die Dose war offensichtlich nicht mehr in ihrem Versteck und lag offen herum. Dann ist es sinnvoll sie dort zu verstecken, wo man vermutet, dass sie vorher versteckt war. In diesem Fall sollte man am besten zusätzlich noch den [[Owner]] darüber informieren, wie man die Dose vorgefunden und wie man sie versteckt hat (am besten mit Fotos). Sollte es sich dann nicht um das richtige Versteck handeln, kann der Owner darauf reagieren, aber der Cache ist auf jeden Fall erst einmal gerettet.

== Und danach? ==
'''Heim zum [[Das Onlinelog|Onlinelog]].'''

[[Kategorie:Opencaching]]

[[pl:Szukanie skrzynki]]

Entwicklung/Git

2016-06-28T11:56:26Z

Teiling88:

== Versionsverwaltung der Entwicklungsdaten mit Git ==
Das Opencaching.de-Projekt verwendet [http://git-scm.com/ Git] zur Verwaltung von Quellcode, Dokumentationen etc. Git ist leistungsfähiger und komplexer als klassische Versionsverwaltungstools wie CVS und Subversion. Es kann wesentlich besser mit Branches umgehen, also verschiedenen Codeversionen eines Projekts -- "branches (in Git) are cheap and easy". So kann man zu Testzwecken, zum Programmieren einzelner Features etc. eigene Zweige anlegen, die dann später wieder in den Haupt-Code (den ''Master-Branch'') einfließen oder wahlweise verworfen werden. Dieses Verzweigen und Wieder-Zusammenführen von Codeversionen ist erstaunlich einfach und zuverlässig. Richtig eingesetzt, erleichtert es das Projektmanagement.

Die Verwendung von Git setzt eine gewisse Lernkurve voraus. Diese Anleitung soll dir den Einstieg erleichtern und erklärt alles, was du für den Git-Einsatz bei Opencaching.de wissen musst (und Einiges mehr). Sie erklärt die Verwendung von Git anhand der Kommandozeilenversion, die für alle relevanten Betriebssysteme erhältlich ist. Daneben gibt es verschiedene komfortable Benutzeroberflächen. Gerne kannst du ein weiteres Kapitel für die von dir bevorzugte Git-UI hinzufügen!

Allgemeine Einführungen in Git findest du z.B. hier (Liste gerne ergänzen):
* http://rogerdudler.github.io/git-guide/index.de.html - Der einfache Einstieg (deutsch)
* http://gitref.org/index.html - eine leichtverständliche Einführung
* http://stefanimhoff.de/2009/einstieg-in-git-als-versionskontrollsystem - Einstieg in Git (deutsch)
* http://git-scm.com/documentation - offizielle Dokumentation

== Installation ==

Git-Download

... für Windows: http://code.google.com/p/msysgit/downloads/list?q=full+installer+official+git 
... für Mac: http://code.google.com/p/git-osx-installer/
Installation per Installationsprogramm und Standardeinstellungen. Zur Installation in der Entwickler-VM siehe [[Entwicklung/Entwicklersystem|Entwicklersystem]].

Nach der Installation von Git muss du einmalig deinen Name und eine Emailadresse eingeben:
git config --global user.name "Your Name Here"
git config --global user.email "your_email@youremail.com"
Diese Information wird später - für jeden einsehbar - zusammen mit jedem Codebeitrag (''commit'') von dir gespeichert. Verwende eine Emailadresse, die veröffentlicht werden darf, und ggf. einen Nickname. Diese Daten werden in der Datei <code>.gitconfig</code> in deinem Benutzerverzeichnis abgelegt.

== Funktionsweise von Git und Einsatz bei Opencaching.de ==

Git arbeitet im Gegensatz zu Subversion ''dezentral''. Jeder Entwickler hat eine eigene Kopie - einen "Klon" - des Repositories, also der Datenbank in der sich alle Dateien des Projekts in allen Branches und Versionsständen befinden. Aus diesem Klon werden die Arbeitsdaten ausgecheckt, und Änderungen der Arbeitsdaten werden dort eingecheckt.

Die Entwickler können in beliebigen Topologien organisiert werden und gleichen den Inhalt ihrer Repositories wechselseitig miteinander ab. Opencaching.de verwendet eine Art Sternstruktur, mit einem Haupt-Repository unter der Adresse
* http://github.com/OpencachingDeutschland/oc-server3

Auf dieses Repo haben nur der Code Maintainer und seine Vertreter Schreibzugriff; alle anderen können nur lesen. Um auch Daten hochladen zu können, besitzt jeder Entwickler bei Github.com eine eigene Kopie - einen "Fork" - des Haupt-Repositories, z.B.
* http://github.com/flopp/oc-server3

Dein erster Schritt als Opencaching-Entwickler ist das Anlegen deines Forks. Dazu legst du dir auf [http://github.com Github] einen kostenlosen Account an, gehst auf http://github.com/OpencachingDeutschland/oc-server3 und klickst oben rechts auf "Fork".

Der zweite Schritt ist, dir eine lokale Kopie - einen "Klon" - deines Forks anzulegen. Wie du das im OC.de-Entwicklersystem machst, ist im Artikel [[Entwicklung/Entwicklersystem|Entwicklersystem]] beschrieben. Hier machen wir es einfach mal testweise - du kannst so viele Klone anlegen wie du möchtest, den Github-Repositories ist das egal:
git clone git://github.com/<DeinBenutzername>/oc-server3

Nun wird bei dir ein Verzeichnis <code>oc-server3/.git</code> angelegt, das zunächst eine 1:1-Kopie deines Github-Forks ist (der zunächst eine 1:1-Kopie des Opencaching-Deutschland-Repos ist), und von dort der komplette aktuelle OC.de-Code in Unterverzeichnisse von <code>oc-server3</code> ausgecheckt. In <code>oc-server3</code> befinden sich also sowohl deine Arbeitsdaten als auch der lokale Repository-Klon. <code>oc-server3/.git/config</code> ist die Konfigurationsdatei des lokalen Repositories, die du aber nur selten von Hand bearbeiten wirst.

Dein Github-Fork heißt in deinem lokalen Repository ''origin''; über diesen Name kannst du mit verschiedenen Git-Kommandos darauf zugreifen. Um die Konfiguration abzuschließen, muss zusätzlich noch der ''upstream'' definiert werden - das Repository, aus dem du neue Daten abrufst. Dies ist nicht dein eigener Fork, sondern du beziehst die Daten direkt von OpencachingDeutschland:
git remote add upstream http://github.com/OpencachingDeutschland/oc-server3

Mit <code>git remote -v</code> kannst du dir nun alle "remote"-Repositories anzeigen lassen, die in deinem Klon eingestellt sind.

== Datenfluss ==

Die folgende Grafik zeigt den Git-Datenfluss im Opencaching-Team am Beispiel von drei Entwicklern. Oben siehst du die "remote"-Repositories - das für alle Entwickler als "upstream" dienende Haupt-Repo und die drei "origin" genannten Forks -, und unten die drei lokalen Repositories und die Arbeitsdaten. Die grauen Pfeile zeigen, was du eben gemacht hast: 1. den Fork auf Github.com, und 2. das Erzeugen des lokalen Klons (nicht erschrecken lassen durch die vielen Details - das wird unten alles schrittweise erklärt):

[[Datei:Git-Workflow.png|800px]]

Die schwarzen Pfeile zeigen, wie ''ab sofort'' die Daten fließen werden: In umgekehrter Richtung! Du beziehst Daten vom ''upstream'', schiebst deine eigenen Änderungen in deinen ''origin'', und von dort übernimmt der Code Maintainer sie wiederum in den ''upstream''. Aus Sicht jedes Entwicklers fließen die Daten also zwischen drei Repositories im Kreis.

Links und in der Mitte ist der Standard-Git-Workflow zu sehen, rechts ein vereinfachter mit nur einem Branch.

== Daten bearbeiten und hochladen ==

Nach dem ersten Auschecken ist der ''development''-Branch aktiv. Dieser enthält den aktuellen Entwicklungsstand. Welcher Branch aktiv ist, siehst du mit
<code>git branch</code>
Unser Standard-Workflow sieht vor, dass '''nie im development gearbeitet wird'''. Stattdessen musst du dir - ausgehend von ''development'' - für jede Aufgabe einen Arbeitsbranch anlegen:
<code>git checkout -b 1234-new-feature development</code>
Die vorangestellte Nummer ist eine Ticketnummer aus der Todo-Liste. Wenn es keine passende gibt, lässt du sie weg. Verwende nach Möglichkeit englische Namen und Kommentare, denn das OC-Projekt ist international vernetzt. Nun kannst du mit <code>git branch</code> sehen, dass es in deinem lokalen Repo zwei Branches gibt, und der neu angelegte ist aktiv. Mit dem Kommando <code>git checkout Branchname</code> kannst du zwischen den Branches hin- und herwechseln; dabei wird jeweils der Code in den Arbeitsdaten entsprechend ausgetauscht.

Beim Anlegen des Branches sind wir davon ausgegangen, das unmittelbar zuvor der Klon angelegt wurde und die lokale development-Kopie aktuell ist. Wenn Letzteres evtl. nicht der Fall ist, solltest du sie vor dem Anlegen des neuen Branches aktualisieren:
git checkout development
git pull upstream
git checkout -b 1234-new-feature [development]

Nun ist es soweit: Du kannst deine ersten Änderungen am OC-Code vornehmen und hochladen! Zum Bearbeiten musst du einen UTF8-fähigen Editor verwenden. Dass er das ist, erkennst du an den zwei japanischen Sonderzeichen oben in jeder Quelltextdatei: Wenn dort zwei Fragezeichen, Klötzchen oder Ähnliches erscheinen, ist dein Editor falsch eingestellt oder ungeeignet. Zum Thema Editoren/IDEs siehe auch im Forum: "[http://forum.opencaching.de/index.php?topic=2150.0 Git-UI / PHP-IDE]"

Wenn du die Änderungen vorgenommen hast, zeigt dir
<code>git status</code>
in roter Farbe an, welche Dateien geändert oder hinzugefügt wurden, und
<code>git diff</code>
die Änderungen im Einzelnen. Falls dein Editor bzw. deine Eintwicklungsumgebung irgendwelche zusätzlichen Dateien angelegt hat, kannst du diese in <code>.git/info/exclude</code> eintragen, damit sie nicht ins Repository gelangen.

Als nächstes musst du Git mitteilen, dass die Daten zum aktiven Branch hinzugefügt werden sollen; dies geschieht mit
<code>git add .</code>
für alle geänderten und neuen Dateien im aktuellen Verzeichnisbaum (falls du Branches gewechselt hast vergewissere dich evtl. mit <code>git branch</code>, dass du im richtigen bist!) Wahlweise kannst du einzelne Dateien per (Pfad+)Dateiname hinzufügen oder Wildcards verwenden. Dateien löschen kann man mit
<code>git rm Dateiname</code>
Nun zeigt <code>git status</code> in grüner Farbe alle vorbereiteten Änderungen an, und mit
<code>git commit</code>
checkst du sie in dein lokales Repository ein. Es öffent sich ein vi-Editor, in dem du einen Kommentar eingeben musst. Schreibe eine aussagekräftige, möglichst englische Zusammenfassung in die erste Zeile, und evtl. zusätzliche Erläuterungen in die weiteren Zeilen. Wenn es nur ein einzeiliger Kommentar sein soll, kannst du dir den Editor auch sparen und den Kommentar direkt angeben mit
<code>git commit -m "Kommentar"</code>
Wenn keine neuen Dateien hinzugefügt, sondern nur vorhandene geändert werden sollen, kannst du auch das <code>add</code> mit einbauen, also alle geänderten Daten mit nur einem Befehl einchecken:
<code>git commit -am "Kommentar"</code>
Mit
<code>git log</code>
siehst du nun, dass ein neuer ''commit'' in die Versionsgeschichte des aktiven Branches eingefügt wurde. Wahlweise kannst du auch mit <code>git log --stat</code> nochmals alle geänderten Dateien anzeigen lassen.

Um den Commit mit einem Ticket in der [[Entwicklung/Todo-Liste|Redmine-Todo-Liste]] zu verknüpfen, kannst du im Kommentar das Stichwort "updates #nnn" einfügen, mit #nnn = Redmine-Ticketnummer. Der Commit erscheint dann innerhalb des Tickets, sobald er geprüft und in den ''development''-Branch übernommen wurde.

==== Exkurs: commits ====

Commits sind das Hauptelement der Arbeit mit Git. Jeder Branch ist eine bestimmte Abfolge von Commits. Verschiedene Branches unterscheiden sich dadurch, welche Commits sie enthalten. Ein Commit ist ein Patch, der eine oder mehrere Dateien verändert, hinzufügt und/oder löscht. Jeder Commit hat einen eindeutigen Hashcode, der im Log angezeigt wird. Über diesen Code lassen sich Commits einzeln herauspicken, rückgängig machen, als Diff anzeigen etc. Dabei genügt die Angabe der ersten paar Zeichen, sofern sie eindeutig sind; üblich als Kurzform sind die ersten 7-10 Zeichen.

Der letzte (neueste) Commit des aktiven Branches hat auch den Name HEAD, der vorletzte HEAD~1, der drittletzte HEAD~2 etc. Mit
<code>git diff HEAD~1</code>
kannst du dir z.B. alle Änderungen zwischen aktuellem und vorletztem Codestand anzeigen lassen - also genau das, was du mit deinem letzten <code>commit</code> eingecheckt hast.

==== Rebase auf aktuellen Codestand ====

Grundsätzlich solltest du Daten erst dann hochladen, wenn sie verwendbar sind und in das Haupt-Repository oder an einen anderen Entwickler weitergegeben werden sollen. Unfertiges bleibt zunächst nur lokal bei dir liegen. Wir tun jetzt einfach mal so, als sei deine Codeänderung fertig (du kannst den Upload danach wieder löschen, wenn es nur ein Test war).

Zunächst solltest du deine Daten nochmal auf den aktuellen Stand bringen. Damit ist sichergestellt, dass deine Änderungen mit dem aktuellsten OC-Code funktionieren:
git fetch upstream
git rebase upstream/development

Das erste Kommando aktualisiert deine lokale Kopie der Upstream-Branches (die du mit <code>git branch -r</code> auflisten kannst), bzw. legt diese erstmalig an. Das zweite übernimmt alle neuen ''commits'' aus dem Upstream - also dem OC-Hauptrepository - in deinen aktiven Branch, und zwar fügt es sie ''vor'' deine eigenen Änderungen ein! Deine Änderungen werden auf Basis des aktuellen OC-Codestandes neu aufgesetzt (re-based), d.h. sie werden als Patch auf diesen Codestand angewandt. Beide Kommandos lassen sich auch zu einem zusammenfassen:
git pull --rebase upstream development

'''Verwende niemals ein einfaches <code>git pull</code> (ohne <code>--rebase</code>) in einem Arbeitsbranch!''' Es würde die Versionsgeschichte unlesbar machen und das Zurückverfolgen von Codeänderungen verhindern.

Beim <code>rebase</code> können "Merge-Konflikte" enstehen, wenn deine Codeänderungen nicht automatisch auf dem aktuellen Codestand aufgesetzt werden können, z.B. weil es mehrere Änderungen in der gleichen Codezeile gab. Git zeigt dann eine Fehlermeldung an, und die Konflikte sind in im Quelltext markiert (suche nach "===="). Korrigiere den Code, markiere die geänderte Datei erneut mit git add zum Hinzufügen, und gib <code>git rebase --continue</code> ein, um das Rebase abzuschließen.

==== Daten hochladen ====

Nun kannst du deinen neuen Branch mit
<code>git push origin 1234-new-feature</code>
in deinen Fork hochladen. Wenn du auf [http://github.com/ http://github.com/<DeinUsername>/oc-server3] links die Branch-Dropdown-Box aufklappst, oder weiter rechts auf "branches" klickst, sollte dort der neue Branch auftauchen (manchmal mit etwas Verzögerung). Wenn du oben auf "Network" klickst, siehst du wie dein neuer Branch vom development abzweigt. Jeder Punkt in diesem Diagramm steht für einen ''commit''.

Wenn dein Branch fertig ist und in den development übernommen werden soll, wählst du ihn aus der Branches-Liste aus und klickst oben auf "Pull Request"; hier kannst du noch einen zusätzlichen Kommentar angeben. Der Code Maintainer wird per E-Mail informiert und wird deinen Code prüfen und ggf. übernehmen.

In diesem Fall war es wahrscheinlich nur ein Test, daher kannst du den Branch nun mit
git push origin :1234-new-feature
wieder aus deinem Fork löschen. Wenn du ihn auch lokal wieder löschen willst, geht das mit
git checkout development
git branch -D 1234-new-feature

Das große <code>-D</code> ermöglicht es, einen Branch zu verwerfen, der nicht weiterverwendet wurde. Wenn du stattdessen <code>-d</code> angibst, sind nur Branches löschbar die bereits in einen anderen Branch (z.B. den development) übernommen wurden, wo durch die Löschung also keine Daten verloren gehen können. '''Im Zweifelsfall verwende immer -d'''; dabei kann nichts versehentlich verloren gehen.

==== Zusammenfassung des OC-Git-Standard-Workflow ====

Neuen Branch für eine neue Aufgabe anlegen:

1. <code>git checkout development</code> 
2. <code>git pull upstream</code> 
3. <code>git checkout -b 1234-new-feature</code>
... oder die Arbeit an einem bereits bestehenden Branch mit <code>git checkout 1234-new-feature</code> fortsetzen

Programmierzyklen:

4. Code schreiben 
5. mit <code>git status</code> / <code>git diff</code> lokale Änderungen kontrollieren 
6. Änderung mit <code>git add</code> / <code>git commit</code> ins lokale Repo einchecken 
7. mit <code>git pull --rebase upstream development</code> auf aktuellen OC-Code aufsetzen 
8. weiter bei 4, wenn der Code noch nicht fertig ist

Hochladen:

9. <code>git push origin 1234-neues-Feature</code> 
10. ''Branch 1234-neues-Feature'' im Github aufrufen und Pull Request starten

Nicht mehr benötigte Branches löschen:

11. lokal: <code>git checkout development</code> / <code>git branch -d 1234-neues-Feature</code> 
12. auf dem Fork: <code>git push origin :1234-neues-Feature</code>

==== Commits zusammenfassen ====

Wenn in Schritt 4-8 mehrere Einzelcommits entstehen, kannst du sie vor dem Hochladen zur besseren Übersicht zu einem zusammenfassen. Prüfe mit <code>git log</code> nach, wieviele Commits zusammenzufassen sind - sie sollten noch nicht hochgeladen sein! - und gib ein:
git rebase -i HEAD~n
... wobei n die Zahl der Commits ist. Nun erscheint ein Editorfenster mit einem "pick" je Commit. Ersetze alle "picks" ab dem zweiten durch "squash" oder "s", was bedeutet, dass sie mit dem Commit davor zusammenzufassen sind. Nach dem Speichern erscheint ein zweiter Text im Editor, in dem du auch die Commit-Kommentare zusammenfassen kannst.

Wenn du dir '''ganz sicher''' bist, dass ein bereits hochgeladener Commit noch nicht weiterverwendet wurde - z.B. wenn du ihn eben erst hochgeladen und noch keinen Pull Request gemacht hast - kannst du ihn auch noch nachträglich mit neuen Commits zusammenfassen. Dies funktioniert wie oben beschrieben, allerdings musst du beim anschließenden <code>push</code> zusätzlich <code>--force</code> angeben, um den/die alten Commit(s) in deinem Fork zu überschreiben.

== Aktuelle Daten holen; mehrere Änderungen testen ==

Wenn du selbst gerade nichts programmieren willst, sondern dir einfach nur ein Update vom OC-Server holen und anschauen, machst du
git checkout development
git pull upstream
Wenn du mehrere Branches mit eigenen Änderungen angelegt hast, und diese alle im Zusammenhang testen möchtest, kannst du dir dafür einen Testbranch anlegen:
git checkout -b test development
git merge 1234-new-feature
git merge 2345-my-bugfix
...

== Änderungen verwerfen ==

* alle geänderten Dateien: <code>git reset --hard</code>
* alles geänderten Dateien im aktuellen Verzeichnisbaum: <code>git checkout .</code>
* alle neuen, noch nicht hinzugefügten Dateien: <code>git clean -f -d</code>
* nur eine bestimmte Datei: <code>git checkout Dateiname</code>

... die bereits "commitet", aber noch nicht "gepusht" sind:
* <code>git reset --hard HEAD~n</code>

... wobei n die Zahl der zu verwerfenden Commits ist. Wenn die Änderungen bereits "gepusht" wurden:
* mit <code>git log</code> die rückgängig zu machende Commit-ID raussuchen
* <code>git revert commit-ID</code>
* <code>git push</code>
* evt. Pull-Request auf dem Github, wenn es bereits im Upstream angekommen war

Den Kommentar des letzten, noch nicht "gepushten" Commit korrigieren:
* <code>git commit --amend</code>

== Daten direkt von anderen Entwicklern holen ==

Wenn du z.B. den Branch ''1234-new-feature'' von Entwickler ''heinz'' testen möchtest, kannst du ihn in einen Testbranch bei dir herunterladen. Zunächst musst du ''heinz''' Fork einmalig als weitere Upstream definieren:
git remote add heinz http://github.com/heinz/oc-server3
Dann legst du bei dir einen Testbranch an, am besten auf Basis aktuellster Daten ...
git checkout development
git pull upstream
git checkout -b tolles-heinz-feature
... und mergst seinen Feature-Branch in deinen Testbranch:
git pull heinz 1234-new-feature

== Der stable-Branch ==

Neben dem development gibt es im OC-Repository einen Branch "stable". Dieser enthält immer den gleichen Stand wie das Produktivsystem www.opencaching.de. Neue Features werden im development entwickelt und getestet und später über den Stable-Branch freigegeben.

Mit dem Stable-Branch wirst du nur dann zu tun haben, wenn du einen "Hotfix" schreibst - eine dringende Korrektur, die sofort freigegeben werden soll. Diese setzt du auf dem Stable statt dem development auf; der übrige Workflow ist der gleiche wie oben beschrieben.

== Vereinfachter Workflow ==

Der oben beschriebene Workflow ist Pflicht für alle Entwickler, die Code zu OC.de beitragen. Wer nur hin und wieder mal eine Grafik oder einen Text beisteuert, kann ausnahmsweise auch ohne separate Branches arbeiten. In diesem Fall ist ein '''einfaches <code>git pull</code> im development-Branch verboten'''! Stattdessen muss überall, wo oben <code>git pull upstream</code> steht, stattdessen
<code>git pull --rebase upstream development</code>
verwendet werden! Der vereinfachte Ablauf ist dann:

1. Code schreiben 
2. mit <code>git status</code> / <code>git diff</code> lokale Änderungen kontrollieren 
3. Änderung mit <code>git add</code> / <code>git commit</code> ins lokale Repo einchecken 
4. mit <code>git pull --rebase upstream development</code> auf aktuellen OC-Code aufsetzen 
5. weiter bei 1, wenn der Code noch nicht fertig ist 
6. <code>git push origin</code> 
7. Pull-Request

== Noch ein paar Gimmicks ==
<code>git diff Branchname</code>

zeigt alle Unterschiede zwischen dem aktuellen Branch und einem anderen an.

<code>git cherry-pick Commit-ID</code>

übernimmt einen bestimmten Commit (von wo auch immer) in den aktiven Branch.

<code>git diff --name-only --diff-filter=U</code>

zeigt eine Liste aller konfliktbehafteten Dateien nach einem Merge an

<code>git gc</code>

führt eine [http://de.wikipedia.org/wiki/Garbage_Collection Garbage Collection] durch und gibt Platz im lokalen Repository frei. Per <code>git reset --hard</code> oder <code>git branch -d</code> gelöschte Commits werden damit endgültig weggeworfen (vorher sind sie via <code>git reflog</code> noch wiederherstellbar).

<code>git grep Suchbegriff</code>

durchsucht den Code des aktuellen Verzeichnisbaums; für zahlreiche Optionen siehe Git-Doku.

<code>git help Kommando</code>

zeigt die Doku für ein Git-Kommando an.

== Forenbeiträge zu Git ==
* [http://forum.opencaching.de/index.php?topic=2125.0 Git-Workflow]

[[Kategorie:Entwicklung|Git]]