Dies ist der Hacker's Guide des LugFrameworks der Linux User Group Krefeld. Nachdem ich bisher einige längere Mails mit anderen Team-Mitgliedern ausgetauscht habe, habe ich mir überlegt, daß man Dinge, die zu sagen und zu dokumentieren sind, viel besser direkt in die Dokumentation zu unserer Bibliothek einbindet.
Nach wie vor stehen einige der mehr beweglichen Teile der Dokumentation natürlich auf http://www.lug-kr.de/wiki/JavaApplicationFramework
Diese Dokumentation ist Teil des Quelltextes. Ich bitte ausdrücklich jeden Entwickler, hier Verbesserungen und Änderungen vorzunehmen!
Wer einen Zugang zum Mercurial-Server hat, kann mit
hg clone ssh://username@hg.javaproject.de:2222/LugFramework
einen Klon des Repositories erzeugen. Dann kann man das Ant Buildskript starten:
build website
Alle Entwickler arbeiten bisher mit Eclipse, so daß ich das auch noch kurz anspreche. Man sollte in Eclipse das Mercurial Eclipse Plugin installieren. Dann kann man über "Neu/Projekt..." eine Auswahl treffen, das man ein Mercurial-Projekt klonen möchte. Als URL gibt man wie oben an:
ssh://username@hg.javaproject.de:2222/LugFramework
Als allerestes wird Eclipse ein rotes Kreuzchen machen. Keine Panik! Man startet nun erstmal das Ant Buildskript, indem man auf die Datei build.xml mit rechts klickt und dann "Run As/Ant build" ausführt. ''(Wer will, kann das auch von der Konsole oder mit Hilfe des Ant-View von Eclipse machen.)'' Dann aktualisiert man das Projekt, indem man auf die Wurzel des Projektbaums klickt und F5 drückt.
Vor allem ist es wichtig, Feedback zu geben. Das kann per Mail an die Entwickler sein, kann aber auch in Form von TODO-Bemerkungen sein. Wir benutzen einen Standard für einzeilige TODO-Einträge, die man in den Sourcecode, aber auch in Textdateien einträgt. Bemerkungen zum Sourcecode sollten sofort dorthin geschrieben werden,wo das Problem liegt, allgemeine TODOs können in die Datei doc/Aufgaben.txt geschrieben werden.
Einzeilige TODOs können, dürfen und sollen jederzeit in das Repository eingecheckt werden. Wer dennoch Angst hat, kann sich beim ersten Mal einen Repository-Klon auf dem Server erstellen (siehe MercurialServer).