Eigene Projekte beitragen

Wenn ihr ein eigenes Projekt selbst entwickelt und die Entwicklung dokumentiert habt, fügen wir eure Anleitung gerne zu diesem Buch hinzu! Nicht nur eigene Inhalte, auch Korrekturen & Verbesserungen am bestehenden Inhalt sind gern gesehen ;)

Inhalt

Die Dokumentation sollte einen Überblick über das Projekt geben, und eine Schritt-für-Schritt Anleitung zum Nachbau enthalten. Fotos und Programmcode können ebenfalls hinzugefügt werden!

In jedem Fall sollten alle Informationen enthalten sein, sodass das Projekt von anderen wiederholt werden kann!

Falls ihr schonmal mit GitHub gearbeitet habt, könnt ihr uns gerne die Dokumentation per Pull Request im Markdown Format zusenden. Hierfür findet ihr weiter unten eine ausführliche Anleitung.

Alternativ könnt ihr diese Office-Vorlage verwenden, und uns das Dokument einfach per Mail schicken. Wir werden die Dokumentation anschließend in dieses Buch einarbeiten.

Lizenz

Euer Beitrag wird - wie der Rest des Buchs - unter der CC BY-SA 4.0 Lizenz eingefügt. Das bedeutet, dass der Beitrag von anderen frei weiterverwendet werden darf, solange der Autor zusammen mit dem Inhalt genannt wird.

Vielen Dank für euren Beitrag!

Schreiben der Dokumentation in Markdown

Falls ihr den Weg über GitHub gehen wollt, und doch nicht ganz vertraut damit seid, findet ihr hier eine kurze Hilfestellung.

Für die Bearbeitung und Verwaltung dieses Buches verwenden wir github.com und das Tool GitBook, alle Inhalte werden in Markdown geschrieben. Falls ihr nicht vertraut mit Markdown seid, findet ihr hier eine Hilfestellung und Syntaxerläuterung. Sofern sie für euer Projekt geeignet ist, könnt ihr euch an dieser Vorlage orientieren.

Um das Schreiben mit Markdown zu vereinfachen gibt es übrigens auch online-Editoren wie stackedit.

Dateinamen

Achtet darauf, dass in den Dateinamen keine Leerzeichen enthalten sind! Wenn Bilder oder andere Dateien (zB. Arduino-Sketches) eingebunden werden sollen, legt diese einfach im in einem gleichnamigen Unterordner ab:

mobile-wetterstation.md
mobile-wetterstation/uebersicht.jpg
mobile-wetterstation/mobile-wetterstation.ino

Hochladen der Dokumentation

Um uns die Dokumentation zuzusenden, fügt ihr diese am besten in das Buch selber ein.

Der Quellcode dieses Buches ist hier auf GitHub zu finden. Forkt dazu dieses Repository, fügt eure Inhalte dort ein, und erstellt dann einen Pullrequest.

Falls ihr mit git nicht vertraut seid, erfahrt ihr nun im Detail wie das alles funktioniert. Wenn Fragen offen bleiben, stehen wir euch auch gerne per Mail zur Verfügung.

GitHub Account erstellen

Um eigene Beiträge auf GitHub zu erstellen wird dort ein Account benötigt. Erstellt diesen hier. Das kostenlose Konto ist vollkommen ausreichend, da wir keine nicht-öffentlichen Repositories erstellen wollen.

GitHub ist ein Dienst, welcher git-Repositories online bereitstellt. Ein Repository ist ein Verzeichnis für Code und Daten, welche inhaltlich zusammengehören. Zu jedem Repository gehört eine Versions-Geschichte, über welche vorherige Versionen wiederhergestellt werden können. Jede Version wird als Commit bezeichnet.

Repository forken

Durch diese Versionsverwaltung können gleichzeitige Entwicklungsstränge dezentral entwickelt und wieder zusammengeführt werden; einen abgezweigten Entwicklungsstrang bezeichnet man Fork (engl. Gabelung).

Um unser Buch also weiter zu entwickeln, müsst ihr das Quelltext-Repository forken. Besucht dazu die Seite des Repositories, und klickt den Button "Fork" oben rechts.

Das Repository wurde mit dem aktuellen Zustand zu eurem Account kopiert, und ist unter https://github.com/<dein nutzername>/books/tree/book_edu zu finden. Auf dieser Kopie habt ihr Schreibrechte, und könnt euren Inhalt einfügen!

Inhalt einfügen

Fügt eure Dateien in den Ordner de/community_projekte/ ein.

Besucht dazu die Adresse https://github.com/<dein nutername>/books/tree/book_edu/de/community_projekte, wo ihr über die Buttons "Upload files" und "Create New File" Bilder und Textdateien hochladen könnt:

Zusätzlich könnt ihr die Projekt-Anleitung im Inhaltsverzeichnis (de/SUMMARY.md) verlinken, hier ist ein Beispiel:

...
* [Community-Projekte](community_projekte/README.md)
    * ...
    * [Mobile Wetterstation](community_projekte/mobile_wetterstation.md)

...

Pull Request erstellen

Euer Inhalt ist nun zwar online auf Github, aber noch nicht in unserem Repository. Um uns zu benachrichtigen, dass ihr eure Änderung in unser Ursprungs-Repository einfügen wollt, könnt ihr einen Pull Request auf der Github-Weboberfläche erstellen. Erstellt dazu auf der GitHub-Weboberfläche von eurem geforkten Repository einen Pull Request.

Im erscheinenden Fenster könnt ihr eine kurze Beschreibung eurer Änderung und weitere Kommentare angeben. Wählt hier unter Base den Branch book_edu.

Wir werden nun über euren Beitrag informiert und uns eure Änderung ansehen. In den nächsten Tagen solltet ihr eure Anleitung in diesem Buch im Kapitel Community-Projekte finden!

Alternativ zu dem Prozess auf GitHub gibt es auch den Gitbook.com Editor, welcher euch einen Teil der Arbeit auf Github erspart. Auch hier wird allerdings ein Github Account benötigt.