14-03-2015, Saturday-02:21:56
Was bräuchte man denn überhaupt für eine Art Dokumentation?
Würde es nicht für die Meisten (Paksetentwicklern) völlig ausreichen, wenn man bei "Paksetrelevanten" ADD und CHQ -s in einen separaten (das ist ganz wichtig, damit man nicht lange suchen muss, sondern auch findet, was man braucht) Log schreibt, was diese tun/verändern, und wie man diese anspricht?
Das müsste meiner Meinung nach nicht einmal mehr schön ausformuliert, sondern einfach kurz und knapp, im simpelsten english, so dass es jeder lesen kann.
zb.:
https://github.com/aburch/simutrans/comm...dfd6e3ba5c
=>
Fast genau so, wie zur Zeit. Zumindest in diesem Fall war es für mich leichter als leicht das wichtige herauszubekommen.
Aber wenn zb. "more precise city growth calculation" [Link] das einzige ist, was man über einen Commit herausfindet, ist das echt ärgerlich, und schreckt mich auch total ab weiter zu gucken, woran gebastelt wird, da zumindest ich keine Chance mehr habe, einen Überblick zu bekommen. In diesem Fall könnte (rein hypothetisch) dies durchaus auch bedeuten, dass ich neue Möglichkeiten zum Einstellen bekäme, als auch, dass meine bisherigen Einstellungen verfälscht werden, und damit die Paksetbalance gleich mit.
Wenn man ein aufgeräumtes Log hätte, wäre für Pakersteller dann eigentlich nur noch wichtig, ab welcher Revision das ganze testbar ist,
bzw. wie sie herausfinden, ob die Funktion schon unterstützt wird, und damit, ob der Fehler bei ihnen, oder an der fehlenden Unterstützung seitens der genutzten Simutransversion liegt.
Was meint ihr? wäre das eine Lösung?
Der Aufwand für die Programmierer dürfte nicht allzu hoch sein, und mit einer Suchfunktion wäre er auch für Paksetentwickler als Nachschlagwerk nutzbar.
Vielleicht schafft man das sogar, diesen log automatisch zu schreiben, oder die derzeitigen Commits so sortierbar zu machen, dass man nur die für Paksetentwickler relevanten angezeigt bekommt.
Würde es nicht für die Meisten (Paksetentwicklern) völlig ausreichen, wenn man bei "Paksetrelevanten" ADD und CHQ -s in einen separaten (das ist ganz wichtig, damit man nicht lange suchen muss, sondern auch findet, was man braucht) Log schreibt, was diese tun/verändern, und wie man diese anspricht?
Das müsste meiner Meinung nach nicht einmal mehr schön ausformuliert, sondern einfach kurz und knapp, im simpelsten english, so dass es jeder lesen kann.
zb.:
https://github.com/aburch/simutrans/comm...dfd6e3ba5c
=>
Code:
ADD
New building type 'dock'.
Similar to harbour, but on flat ground.
parameter => "type=dock"Fast genau so, wie zur Zeit. Zumindest in diesem Fall war es für mich leichter als leicht das wichtige herauszubekommen.
Aber wenn zb. "more precise city growth calculation" [Link] das einzige ist, was man über einen Commit herausfindet, ist das echt ärgerlich, und schreckt mich auch total ab weiter zu gucken, woran gebastelt wird, da zumindest ich keine Chance mehr habe, einen Überblick zu bekommen. In diesem Fall könnte (rein hypothetisch) dies durchaus auch bedeuten, dass ich neue Möglichkeiten zum Einstellen bekäme, als auch, dass meine bisherigen Einstellungen verfälscht werden, und damit die Paksetbalance gleich mit.
Wenn man ein aufgeräumtes Log hätte, wäre für Pakersteller dann eigentlich nur noch wichtig, ab welcher Revision das ganze testbar ist,
bzw. wie sie herausfinden, ob die Funktion schon unterstützt wird, und damit, ob der Fehler bei ihnen, oder an der fehlenden Unterstützung seitens der genutzten Simutransversion liegt.
Was meint ihr? wäre das eine Lösung?
Der Aufwand für die Programmierer dürfte nicht allzu hoch sein, und mit einer Suchfunktion wäre er auch für Paksetentwickler als Nachschlagwerk nutzbar.
Vielleicht schafft man das sogar, diesen log automatisch zu schreiben, oder die derzeitigen Commits so sortierbar zu machen, dass man nur die für Paksetentwickler relevanten angezeigt bekommt.