Code, Style, Dokumentation, Modularisierung, etc.

Forum for developers

Code, Style, Dokumentation, Modularisierung, etc.

Beitragvon surfvive » Fr Sep 27, 2013 12:35 pm

Ich habe vor einigen Tagen den Code von YaCy ausgecheckt und angefangen, mich ein wenig umzuschauen. Gerne würde ich ein wenig (meiner knappen :D) Freizeit "opfern" und mich an der Entwicklung beteiligen. An Ideen mangelt es nicht unbedingt, jedoch bleiben zunächst einige Fragen offen.
Die TODO-Listen im Wiki haben den Anschein veraltet zu sein, einige Dinge, die getan werden könnten sind im Forum verteilt. Die "fehlende" Dokumentation wurde ja anderweitig schon kritisiert und eine Online Dokumentation des Codes gibt es nicht, obwohl ich diese für Diskussionen sinnvoll halten würde.
Bezüglich des Codes scheint es keine Vorgaben zu geben, meinem Eindruck nach scheinen Tabs und Leerzeichen beliebig genutzt zu werden und eine Beschränkung der Zeichen je Zeilen gibt es nicht(?). Dies würde ich auch für sinnvoll halten, da nicht immer ein Widescreen zur Verfügng steht :).

Abseits von der Kritik stellt sich mir die Frage, wie man sich am besten beteiligen kann, daher würde ich ein paar "Richtlinien" für hilfreich halten. Aus meiner Sicht wäre es am sinnigsten den Ansatz der Modularisierung voran zu treiben, da dies die "sporadische" Beteiligung am ehesten unterstützen würde und auch die Experimentierfreude fördern könnte :D.

Ferner habe ich mal PMD, Checkstyle und FindBugs via Netbeans auf den Code losgelassen, eventuell wäre das auch noch ein Ansatz für den Code-CleanUp/die Aufbereitung.

PS: nebenei würde ich es interessant finden auf der YaCy Website irgendwie die Entwicklungsaktivität zu visualisieren, um die "Vitalität" des Projektes zu verdeutlichen, aber das nur am Rande :roll:.
surfvive
 
Beiträge: 23
Registriert: Do Mai 24, 2012 9:02 am
Wohnort: Hannover

Re: Code, Style, Dokumentation, Modularisierung, etc.

Beitragvon Orbiter » Fr Sep 27, 2013 4:21 pm

Hallo surfvive, super dass du mitmachen willst!

ja wir sind code-anarchisten, ich persönlich bevorzuge spaces aber hin und wieder rutschen mir tabs durch wenn ich wieder mal einen neuen eclipse installiert habe und diese blöde Umkonfigurierung vergessenn habe.

Nach fast 10 Jahren ist es auch nicht ungewöhnlich dass im Wiki was veraltet ist; es hilft aber nicht bei einem Wiki 'warum macht das keiner' zu rufen, deswegen ist es ja ein Wiki damit man es gleich machen kann.

Meine persönlichen Wünsche beim Code Commit sind:
- keine bestehenden Funktionen löschen
- nicht bestehenden Code 'perfektionieren', sondern
- sich was neues ausdenken und einbauen (oder Bugs fixen wenn einer auffällt).

bitte _nicht_ mit Checkstyle etc loslegen, das geht ziemlich in die Hose. Wir haben hier Codeteile mit Reflections und das leitet diese Tools in die Irre.
Wenn du eine Visualisierung möchtest, dann baue dir eine! ansonsten da gucken: http://yacy.net/de/Mitmachen.html da ist ja schon eine :)
Orbiter
 
Beiträge: 5792
Registriert: Di Jun 26, 2007 10:58 pm
Wohnort: Frankfurt am Main

Re: Code, Style, Dokumentation, Modularisierung, etc.

Beitragvon surfvive » Sa Sep 28, 2013 10:17 am

Es ging mir darum "abzulopfen", ob es irgendwelche Konventionen oder Koordinierungen (Roadmap, etc.) gibt, aber wenn das nicht der Fall ist, ist das auch erstmal gut so :).
Bzgl. des Wikis war die Frage, ob das was dort steht noch aktuell ist. Mein Debüt hinsichtlich des Beitragens hab ich dort schon hinter mir :).

Orbiter hat geschrieben:Meine persönlichen Wünsche beim Code Commit sind:
- keine bestehenden Funktionen löschen
- nicht bestehenden Code 'perfektionieren', sondern
- sich was neues ausdenken und einbauen (oder Bugs fixen wenn einer auffällt).

bitte _nicht_ mit Checkstyle etc loslegen, das geht ziemlich in die Hose. Wir haben hier Codeteile mit Reflections und das leitet diese Tools in die Irre.

Ist schon klar, dass man nicht alles für bare Münze nehmen sollte, was diese Tools ausspucken. Es ging mir eher um kleinere Optimierungen, die beispielsweise von PMD vorgeschlagen werden. Aber derartiges schließt Du ja in Punkt zwei eigentlich aus.
Wenn ich das korrekt verstehe sollte das Ziel eher "mehr experimentieren", als das Stabilisieren der vorhandenen Teile sein.
Wie schon geschrieben, wäre meine Präferenz die Modularisierung voranzutreiben. Meine Ziele wären daruf folgend
  • im Späteren eventuell Plug-Ins an YaCy aninden zu können
  • den Scheduler aufbohren (etwa generische Aufgaben, statt nur Crawls planen; adaptive Re-Crawls)
  • Verfahren zur Query-Optimierung Testen und ggf. implementieren
Dafür wäre meiner Meinung nach jedoch wenigstens ein bischen Planung oder Hilfestellung notwendig, da mir dafür bislang der tiefere Einblick in den Code noch fehlt.

Orbiter hat geschrieben:Wenn du eine Visualisierung möchtest, dann baue dir eine! ansonsten da gucken: http://yacy.net/de/Mitmachen.html da ist ja schon eine :)

:mrgreen:
surfvive
 
Beiträge: 23
Registriert: Do Mai 24, 2012 9:02 am
Wohnort: Hannover

Re: Code, Style, Dokumentation, Modularisierung, etc.

Beitragvon Orbiter » Di Okt 22, 2013 2:19 pm

den Scheduler muss man nicht aufbohren, der kann alles was das Interface kann. Dazu muss im entsprechenden Servlet nur eine Zeile hinzugefügt werden, die den Aufruf des Servlets im Scheduler speichert. Das ist daher schon so modular wie man was nur mudular machen kann.

Was meinst du mit plug-ins konkret?
Orbiter
 
Beiträge: 5792
Registriert: Di Jun 26, 2007 10:58 pm
Wohnort: Frankfurt am Main


Zurück zu YaCy Coding & Architecture

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder und 1 Gast

cron