Einführung in das Alricg-Projekt

aus AlricgWiki, der freien Wissensdatenbank

Inhaltsverzeichnis

[bearbeiten]

Für neue Mitarbeiter

Hier sind die ersten Schritte erklärt, die man als neuer Mitarbeiter bei Alricg durchführen sollte. Dazu gehören die Anmeldungen für Wiki, Forum usw. und Einstellungen der Werkzeuge.

[bearbeiten]

Wo überall anmelden

Für jeden der neu ist in dem Projekt, gibt es einige Dinge zu erledigen um die die Kommunikation zwischen den Projektmitgliedern und die Organisation zu erleichtern:

  1. An der BerliOS-Seite anmelden und der Projekt-Leitung den Nick mitteilen, damit man sind das Projekt aufgenommen werden kann. Auf der BerliOS Seite liegt das SVN, die Mailingliste und einige Hilfmittel wie Task-Verwaltung.
  2. Sich auf der Alricg-developer Mailingliste anmelden. Ein großteil der Kommunikation läuft über die Mailingliste. Jedes Projektmitglied kann und soll dort natürlich mitschreiben.
  3. Sich im Wiki anmelden. Das Wiki ist neben der Mailingliste das wichtigste Werkzeug zur Organisation von Alricg, auch hier ist natürlich jeder eingeladen mitzuschreiben.
  4. Sich im Forum anmelden. Im Forum gibt es einen internen Bereich, der nur für Entwickler ist. Hier kann ebenfalls Diskutiert werden.

Das ist natürlich eine ganz schöne Anmelde-orgie... aber das muß man ja auch nur einmal machen :-)

[bearbeiten]

Werkzeuge

[bearbeiten]

Eclipse

Wir empfehlen Eclipse ab Version 3.2 als Entwicklungswerkzeug. Eclipse ist kostenlos runterzuladen, ansonsten gibt es auch ein Eclipse-Magazin im Zeitschriftenhandel, wo die aktuelle Version mit geliefert wird auf CD. Wer sich mit Eclipse garnicht anfreunden kann, kann natürlich auch einanderes Werkzeug benutzen. Wichtig ist das Java 1.5 (bzw. Java 5) unterstützt wird!

  • Nützliche Plug-Ins:
  • Benutztes encoding für alle Editoren: "ISO-8859-1" (gerade bei XML kann es sonst Probleme geben)
  • Task Tags in Eclipse: TODO, VORSICHT, TEST
  • Jede Klasse sollte den Namen des Autors enthalten (bzw. ein Kürzel o.ä.).
  • Wie Eclipse genau zu konfigurieren ist, kann man unter Alricg-Eclipse-Tutorial nachlesen
  • Am Anfang jeder Klasse sollte dieser Text stehen (ist in dem Code-Template enthalten, siehe unten): 
 /* Created on ${date} / ${time}
  * This file is part of the project ALRICG. The file is copyright
  * protected and under the GNU General Public License.
  * For more information see "http://www.alricg.de/".
  */
  • In Eclipse können Vorlagen importiert werden für Code-Templates und Formatter. Aus Gründen der Übersicht sollten alle für das Projekt die gleichen Templates benutzen.
  • Es gibt zwei Ordner mit Source-Code. Zum einen den Ordner "test" und den Ordner "src". Damit der Code ausgeführt werden kann, müssen beide Ordner als "Source-Folder" markiert sein. Bei "src" ist dies standardmäßig der Fall, bei "test" erzeugt ihr einfach einen neuen Source-Folder mit dem Namen "test".
[bearbeiten]

JUnit

Zum Testen benutzen wie automatisierte Tests mit dem Framework JUnit. Jeder der in Alricg Klassen schreibt wird im Normalfall auch eine JUnit Test-Klasse dazu schreiben. JUnit wird von Eclipse unterstützt und kann leicht aus Eclipse benutzt werden (einfach mal aus der Eclipse Hilfe nachsehen). JUnit ist eigentlich recht einfach und sollte kein Problem darstellen. Wenn ihr das Projekt frisch ausgecheckt habt, müsst ihr JUnit noch als Library hinzufügen (Eclipse liefert JUnit mit). Hier solltet ihr Version 4.0 von JUnit nutzen (ab Eclipse 3.2 mit dabei).

Zum Nachlesen:

[bearbeiten]

Subclipse

Subclipse ist ein Plug-In mit dem SVN (der CVS Nachfolger) verwaltet werden kann. Da wir von CVS auf SVN umgestiegen sind, ist Subclipse nun notwendig! Das Plug-In einfach installieren wie auf der Subclipse-Homepage beschrieben. Wie beschrieben das SVN Repository anlegen. Dort werdet ihr zum Eingeben einer URL aufgefordert, dort gebt ihr ein: 

https://EUER_BERLIOS_BENUTZER_NAME@svn.berlios.de/svnroot/repos/alricg

Danach müsst hier beim Verbinden noch euren Usernamen und Passwort aus BerliOS angeben. That's it. (evtl. wird man gewarnt, dass das Zertifikat vom berliOS Server unsicher sei, dann das Zertifikat einfach akzeptieren). Jedenfalls hat es bei mir so geklappt.

[bearbeiten]

Einführung in die Organisation

Es währe schon wenn sich jeder im Projekt kurz vorstellt. Ich denke am besten ist es wenn man auf der Benutzer-eigenden Seite des Wikis ein paar Zeilen zu sich schreiben (wenn man sich angemeldet hat, steht oben der Benutzername. EIn Klick auf diesen Namen und man kann seine Benutzer-Seite bearbeiten).

[bearbeiten]

Mailingliste

Díe Mailingliste ist ein wichtig für absprachen aller Art insbesondere für aktuelles und Dinge die schnell gelesen werden sollen

[bearbeiten]

Wiki

Das Wiki ist für Dokumentation und die "ansammlung von Wissen" gedacht. Alles was auch später zum nachlesen wichtig ist, sollte ins Wiki geschrieben werden. Wer sich mit Wikis nicht auskennt, sollte sich die Hilfe ansehen und erstmal im Sandkasten herumprobieren.
Falls jemand ein Wiki garnicht kennt: In ein Wiki kann jeder (bei uns: angemeldete Nutzer) Reinschreiben und auch die Artikel Anderer verändern.

[bearbeiten]

Forum

Im Forum gibt es einen Bereich der nur von den Entwicklern gelesen werden kann. Dieser Bereich ist für absprachen die für die Mailingliste zu groß sind, aber auch keine Doku sind und daher nicht ins Wiki passen. Bisher wurde das Forum wenig genutzt, aber bisher waren wir ja auch nicht so viele Mitarbeiter.

[bearbeiten]

BerliOS

Von BerliOS wird das SVN benutzt, sowie die Mailingliste. Außerdem bietet BerliOS eine einfache Task-Verwaltung, die wir alldering momentan nicht wirklich nutzen. Wer möchte kann hier seine Aufgaben eintragen, mit einer Schätzung wann diese fertig sind.

[bearbeiten]

Aufgabenverteilung

Die Aufgaben werden i.d.r über das Forum oder die Mailingliste abgesprochen. Eine spezifikation wird außerdem ins Wiki gepostet. Natürlich kann jeder auch selbst Vorschläge machen was er tuen möchte.

[bearbeiten]

Einführung in das Programm

Hierfür sollte man sich erstmal das gesamte Projekt auschecken aus dem SVN.

[bearbeiten]

Ordnerstruktur

Eine kurze übersicht über die Ordern im Projekt (also im Ordner Alricg):

  • doc - Eigentlich für Dokumentationen gedacht, aber nicht mehr genutzt. Kann im Moment ignoriert werden.
  • lib - Für Libraries. Momentan ist hier XOM zu finden, unsere XML-Library.
  • ressourcen - Für alle Daten die das Programm benötigt, aber kein Code sind. Somit sind hier die XML Files zu finden, Bilder und Properties.
  • src - Hier ist der Source-Code von Alricg enthalten
  • test - Auch hier ist Source-Code enthalten. Allerdings sind hier die JUnit Klassen zu finden. Man sollte diesen Ordner in Eclipse auch als Source-Ordner einstellen, damit die jUnit Tests benutzt werden können (siehe auch How To write JUnit Tests).
[bearbeiten]

Starten des Programms

Das Programm ist noch nicht von einer Oberfläche aus benutzbar, und somit auch nur in Teilen zu starten.

  • Die Klasse "org.d3s.alricg.controller.ProgAdmin" ist die eingentliche Start-Klasse. Momentan werden hier aber nur die Daten geladen und das Programm initialisiert - bis auf den SplashScreen ist nicht viel zu sehen.
  • Die Klasse "org.d3s.alricg.JUnitTestAll" (im Ordner "test") ist startet die JUnit Tests.
[bearbeiten]

Dokumentation

Sinnvoll ist hier natürlich die Dokumentation zu lesen, die im Wiki steht. Insbesondere die Artikel:

  1. CharElemente und deren Hierarchie
  2. Das Konzept der Links
  3. Das Konzept des HeldProzessors
  4. Das Konzept der Sonderregeln
  5. Ein Beispiel für die Helden-Verarbeitung
  6. SW-Schichten und Schnittstellen

Auch in dieser Reihenfolge empfohlen.

Von "http://www.alricg.de/devWiki/index.php/Einf%C3%BChrung_in_das_Alricg-Projekt"
'Persönliche Werkzeuge