Banner left   Banner center   Banner right

Germanenglish Home · News · Diary · Screenshots · Documentation (Wiki) · Downloads · Guestbook · Forum

Home · Benutzer registrieren · Suchen · Statistik · FAQ · Benutzerliste

Zur Zeit online: keiner ausser dir

 X-Force - Fight For Destiny - Forum —› Quellcode / Programmierung —› Richtlinien für Programmierer

Autor Mitteilung
verfasst am: 08.06.2004, 20:50 · Edited by: Jim_Raynor
Programmierer

Registrierdatum: 23.08.2003, 19:16

 Beiträge: 2261
Deutsch:

So du möchtest also an X-Force programmieren. Das finde ich schon mal sehr gut und auch die Zahlreichen Fans werden es dir danken. Um Ordnung im Chaos der vielen Quellcodes zu halten und eine gewisse Lesbarkeit sicherzustellen solltest du dich an folgende Regeln.

Die wichtigste Regel zuerst. Halte dich bitte an den Borland Style Guide. Eine Deutsche Übersetzung findest du unter http://www.delphi-source.de/grundlagen/styleguide/. Ich finde nichts Schlimmer als Quellcode der nicht lesbar ist, weil Zeilenumbrüche an der falschen Stelle gemacht werden oder Einrückungen fehlerhaft sind. Auch du willst doch Code bekommen, der leicht lesbar ist. Am besten wird es seien, wenn du versuchst dich an den bisherigen Quellcode zu orientieren.

Das wichtigste Instrument wird der Bugtracker werden. Alle Aufgaben und Entwicklung sollen im Bugtracker verwaltet werden, um Ordnung ins Chaos zu bekommen und doppelte Entwicklungen zu vermeiden. Deshalb sollte immer folgender Weg eingehalten werden, wenn du eine Änderung an X-Force plant:

1. Prüfe bitte, ob bereits im Bugtracker ein entsprechender Beitrag zu deiner Idee vorhanden ist.
1a) Wenn ja, schreibe bitte einen kurzen Kommentar, dass du dich der Sache annimmst.
1b) Wenn nein, dann erstelle bitte einen neuen Eintrag mit dem Hinweis, dass du dabei bist dies umzusetzen.

2. Programmiere die Sachen direkt in deiner Sandbox, um die spätere Veröffentlichung zu vereinfachen.

3. Wichtig ist, dass du deine Änderungen ausgiebig und gewissenhaft testest.

4. Wenn du willst, kannst du dich in die Credits eintragen. Öffne dazu unter /game/bin/settings der Sandbox die credits.txt. Ergänze unter "Freie Programmierer" deinen Namen, wie du ihn gerne hättest.

Wenn du alles programmiert und getestet hast, kannst du dich an die Veröffentlichung machen. Um Ordnung zu halten, musst du deine Änderungen als Datei-Anhang zu dem entsprechenden Eintrag im Bugtracker posten. Um Speicherplatz zu sparen und das Zusammenführen zu erleichtern, musst du ein sogenanntes Patch-File erstellen, dass nur die Änderungen in deiner Sandbox gegenüber den Dateien im Repository darstellt. Um das Patch-File zu erstellen, empfiehlt es sich Tortoise-CVS (siehe "Wie bekomme ich den Quellcode zu X-Force") zu benutzen. Damit musst du nur zum Modul-Verzeichnis in der Sandbox das Kontextmenü aufrufen. Über den Menüpunkt "CVS->Patch erstellen" wird die Patch-Datei mit allen Änderungen in den Verzeichnissen erstellt. Diese Datei musst du nur noch abspeichern und über den Datei-Upload in den Bugtracker hochladen.

Nach dem Upload der Patch-Datei wird ein fester Programmierer die Änderungen prüfen und ins Repository übernehmen. Du bekommst entsprechende Meldung über die Übernahme bzw. nicht Übernahme (mit Begründung) über den Bugtracker mitgeteilt.

Es versteht sich denke mal von selbst, dass wir nicht sofort jeden Programmierer fest als Teammitglied aufnehmen können und einen schreibenden Zugang zum Repository gewähren. Solltest du ernsthaft Interesse haben dem X-Force Team beizutreten und längerfristig zu helfen, dann schicke bitte an das X-Force Team eine Mail. Als Voraussetzung solltest du bereits einige Änderungen an X-Force erledigt haben und diese der Öffentlichkeit zur Verfügung gestellt haben. Nenne bitte den Benutzernamen im Bugtracker in der Mail, damit wir die Qualität deiner bisherigen Arbeit prüfen können und so die Entscheidung über die Teammitgliedschaft vereinfacht wird. Hilfreich wäre auch Referenzen zu bisherigen Delphi-Projekten von dir.

Diese Einschränkung sollte dich trotzdem nicht davor abschrecken Änderungen an X-Force vorzunehmen. Im Forum stehen wir dir gerne zur Unterstützung bereit und hoffen, dass du hilfst X-Force voranzubringen.


English:

So you want to develop on the X-Force-project? I appriciate that and the many fans will do so as well. To keep order in the chaos of the code and to assure its readability you should read the following rules.

Most important rule first: Use the Borland Style Guide. You found it here http://bdn.borland.com/article/0,1410,10280,00.html. There is nothing worse than unreadable sourcecode because of wrong placed line breaks or tabs. As an oriantation you can take a look to the current code.

The most important instrument will be the Bugtracker. All tasks and developing should be administrated by the Bugtracker. With it, we try to prevent chaos and double developing. So please, do the following steps if you plan changes on X-Force:

1. Check out if there is already an article about your idea contained in the Bugtacker
1a) if yes: write a short commentary that you take care of it.
1b) if no: write a new article plus a note that you also take care of it

2. Implement your idea in your Sandbox to simplify a later release.

3. Very Important: do conscientiously testing. There will be a speacial testing giude soon.

4. If you like you can inscribe your name to the credits. Open in your Sandbox under /game/bin/settings 'credits.txt'. Add your name the way you like it under "Freie Programmierer" ('the way you like it' excludes any insults or political and religious incorrect phrases, we don't want jesus to be part of our team)

After implementing and testing your changes you can release it. To do that, you have to attach a file to the entry in the Bugtracker. To save space and to make it easier to merge files you have to create a so called patchfile that only contains the changes between your Sandbox and the repository. To create the patchfile you should use Tortoise-CVS (see also "Wie bekomme ich den Quellcode zu X-Force"). It adds an entry to the contextmenu. So you can open the context menu of the modul-directory in your sandbox and use "CVS->Create Patch" to save the changes to disk. This file is to be uploaded to the bugtracker.

After uploading the file a teammember will check your work and maybe take them over to the repository. You will get a message about the accaptance or denial (with reasons) to the Bugtracker.

It is obvious that we don't want every new developer to become teammember and setup a writing access to the repository him. However if you are really interesseted to join the X-Force-Team you can send a mail to the X-Force Team. To become a member it is required to succesfully release a change on X-Force in the way describe above. please reffer in the mail to the entry in the Bugtracker so we can check the quality of your work. Also you can send references to other delphi-projects you took place in.

This requirements should not scare you to do changes on X-Force. We are available for help at the forum and hope that you will help us to improve X-Force.




Du musst dich registrieren um auf dieses Thema zu antworten.
Login :: » Name » Passwort

Ladezeit (sec.): 0.017 · Powered by miniBB 1.6 with parts of 1.7 © 2001-2003