Subject: Studium

Falls das entsprechende Projekt auf Github existiert und du dort einen Account (und entsprechende git-Kenntnisse hast), kannst du es forken, die Korrekturen direkt einpflegen und mir ein pull-request senden. Dieser weg ist besonders dann lohnend, wenn du vorhast, regelmäßig Korrekturen zu senden.

Alle Projekte sollten auf meinem git-server existieren. Du kannst sie von dort clonen, die Änderungen einpflegen und mir einen patch schicken. Angenommen, du möchtest mir Korrekturen zu meinen Funkana-Mitschrieben schicken, dann geht das ungefähr so:

$ git clone git://git.merovius.de/funkana_mitschrieb # Das repository clonen
$ cd funkana_mitschrieb
$ vim funkana_11-04-12.tex          # Mit deinem Lieblingseditor die entsprechenden Änderungen machen
$ git diff --check                  # Schau dir an, was du geändert hast, und ob du zufrieden bist
$ git add sing_11-04-12.tex         # Füge alle Dateien, die du geändert oder hinzugefügt hast, zum
                                    # index hinzu.
$ git commit                        # Hiernach wirst du nach einer commit-Message gefragt, die
                                    # deine Änderungen zusammenfässt
$ git format-patch origin/master    # Dies sollte eine Datei "0001-*.patch" erstellen
$ git reset --hard origin/master    # Ohne diese Zeile werden zukünftige Aufrufe von "git pull" nicht
                                    # funktionieren

Wenn du viel Angst vor git hast, kannst du statt Zeilen 5 bis 7 auch einfach git diff --check > changes.patch eingeben. Dann stehst du allerdings nicht als Autor im commit und ich muss mir eine commit-message ausdenken. Ich persönlich finde es relativ wichtig, dass die deine Unterstützung auch honoriert wird, selbst wenn du selbst da nicht so viel Wert drauf legst. Von daher bevorzuge ich eigentlich obigen Weg.

Wenn selbst das noch zu viel git ist, dann existiert auf meinem git-server zu jedem Projekt ein Download-link auf der Unterseite des jeweils letzten commits (auf http://git.merovius.de/ zuerst das passende Projekt auswählen, dann auf die oberste commit-message klicken und dann unter download das aktuelle tar.gz-archiv runterladen). Du kannst dann die Dateien bearbeiten und mir anschließend je nachdem wie du willst gepackt per Mail schicken (dann aber bitte nur die geänderten Dateien, nicht das komplete Source-archiv) oder irgendwo hochladen und mir den Link schicken. Für windows-user ist das leider der komfortabelste Weg, mir Änderungen zu schicken, von dem ich weiß (es sei denn, du installierst cygwin und/oder git).

Schreib einfach kurz auf, welche Fehler du gefunden hast und schick mir das per Mail, oder sag es mir mündlich. Das ist natürlich nur für kleinere und wenige Fehler sinnvoll.

Ich defeniere in header-files meistens viele eigene Makros, um häufig vorkommende Zeichen oder Befehle abzukürzen. Schau doch bitte in das jeweilige header-file und benutze gegebenenfalls die entsprechenden Makros. Nur so lässt sich ein einheitliches Design über das gesamte Projekt einhalten. Wenn du glaubst, dass die Makros schlecht sind, oder nicht den gewünschten output erzeugen, dann sag mir das, damit ich sie korrigieren kann und so das Projekt einheitlich bleibt.

Entferne unnötigen whitespace am Zeilenende. git diff zeigt solchen whitespace standardmäßig deutlich in rot an. Also benutze bevor du den patch erstellst doch git diff und achte darauf, das macht mir die Arbeit leichter.

Wenn du git benutzt, teile deine Änderungen in mehrere logische Einheiten auf und erstelle einen commit per Einheit. Wenn ich z.B. im gesamten Projekt „separabel“ falsch geschrieben habe, dann erstelle einen „Ändere seperabel in separabel“ oder ähnlich, in dem du einmal im gesamten Dokument per suchen und ersetzen diesen Fehler korrigierst und korrigiere auch nur diesen Fehler im commit. „Some changes“ oder „Some error corrections“ ist im Regelfall keine sinnvolle commit-message.