WBCE CMS Forum

WBCE CMS – Way Better Content Editing.

Du bist nicht angemeldet.

#1 29.07.2015 20:32:52

easyuser
Mitglied

Coding Standards - oder wie gemeinsam am Core arbeiten?

Hallo zusammen,

Coding Standards ist ja immer so ein Thema.
DarkViper ist ja hier ein Verfechter: http://wiki.websitebaker.org/doku.php/dev/all/psr

Ich persönlich bin der Meinung, dass man schon einige Standards beherzigen sollte, DarkViper schießt hier aber aus meiner Sicht über das Ziel hinaus, weil die Standards für eine Version gemacht sind, die es gar nicht gibt.
Aber gerade bei einem Neuprojekt wie WBCE sollte man es als absolut wichtig nehmen, da man "sich ja erst mal beschnuppern muss".

Ebenso nicht ganz unwichtig finde ich: Wie soll der Kommentarheader in jeder PHP Datei aussehen? Soll er gleich bleiben wie bei WB Classic, oder sich hier ändern?
cwsoft hat hier ja einen nicht unwichtigen, wie ich finde aber richtigen commit gemacht: https://github.com/WBCE/WebsiteBaker_CommunityEdition/commit/6d1775ec2ce287d6d41aa6ac85ae5739ab1eb59c

Ebenso hat norhei hier - natürlich aus ganz anderem Grunde - den Header leicht verändert:
https://github.com/WBCE/WebsiteBaker_CommunityEdition/commit/f9b8e795cfac3bec12f86e9a0024819ee5a9eabf

Meine persönliche Ansicht zum File-Header: Sollte schon so bleiben wie bisher bzw. die Verbindung zu WB Classic soll ja bestehen bleiben.
Die Tags @version, @filesource und @lastmodified sind evtl. noch zu überdenken, v.a. da git ja keine aufsteigende Versionsnummer wie SVN bietet.

Offline

#2 29.07.2015 20:39:47

florian
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Was DV verfechtet oder nicht, geht mir am A**** vorbei. Ich möchte den Namen hier eigentlich nicht lesen müssen.
Bitte macht das so, wie Ihr das für richtig haltet. Die Frage ist halt, was lizenzrechtlich an Unabhängigkeit/Ablösung machbar ist; zu viel WB-Hörigkeit wäre allerdings m.E. auch der falsche Weg.


Code allein macht nicht glücklich. Jetzt spenden!

Offline

#3 29.07.2015 20:50:44

norhei
Developer

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

<Achtung Ausbruch>
Ganz im ernst , die Dateiheader sind so ziemlich das letzte wo ich mir Gedanken drumm mache. Erst mal das eigene Logo draufsetzen, warum? 98% ist noch nicht mal von uns. Und sowiso, wer liest den Scheiss. Ich ärger mich nur immer und muss runterscrollen. Temporäre Dateien einfach unter WTFPL stellen und ansonsten weg mit dem header , bis auf das Linzensmässig absolute Minimum. Wen interessieren diese Eintrage , ich hab sie noch nicht einmal im Leben gebraucht und ich bin echt schon ein alter Sack. Wenn ich was über die Datei wissen will schau ich in GIT nach, da gibts dann auch alle Versionen. WEG MIT DER KACKE!!!
</Achtung Ausbruch>

Jetzt gehts besser und ich geh noch ein bischen was am Core reparieren   lol
Komm doch einfach mit ....

Beitrag geändert von norhei (29.07.2015 20:54:19)

Offline

#4 29.07.2015 20:53:02

florian
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

WTFPL ist auch meine Lieblingslizenz. smile


Code allein macht nicht glücklich. Jetzt spenden!

Offline

#5 29.07.2015 20:55:21

norhei
Developer

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Vielleicht solten Wir wirklich alles was Wir neu machen unter WTFPL stellen ?

Offline

#6 29.07.2015 20:56:24

norhei
Developer

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Ist die GPL kompatibel?

Offline

#7 29.07.2015 21:02:00

florian
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Ist die GPL kompatibel?

Weiß nicht.

Spaß beiseite. WTFPL ist für Kram, in den man eh nicht viel Zeit und Energie gesteckt hat bzw. der sich komplett der Kontrolle entzieht, prima. Irgendein zusammengeschludertes Template, Knipsbilder, Drei-Zeilen-jQuery-Geschichten oder so.

WBCE sollte aber schon unter irgend einer ernsthaften Lizenz stehen, a) aus Wertschätzung gegenüber denen, die da Mühe und Zeit reinstecken; b) aus Marketinggründen und c) um zu verhindern, dass irgendwelche Egoisten von der Arbeit profitieren, ohne etwas davon an die Community zurück zu geben.


Code allein macht nicht glücklich. Jetzt spenden!

Offline

#8 29.07.2015 22:14:59

cwsoft
Mitglied

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Die Fileheader sind in Zeiten von Git und Co. in der Tat überflüssig. Die @version, @lastmodified etc. tags braucht niemand. Die Historie einer Datei sagt mir Git blame und die anderen Tools. Ich würde es auch möglichst kurz halten. Silverstripe und Contao machen das recht schön. Sind auch beide auf Github vertreten, inkl. ausgelagerter Module. Evtl. mal anschauen.

Coding Guidelines sind da schon sinnvoller.


Account inactive since 2018/11/17.

Offline

#9 30.07.2015 09:52:00

webbird
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Zum Header: Wir handhaben das bei BC so, daß original übernommene Dateien alle Vorgänger nennen, also WB, LEPTON und zum Schluß BC. Alle neu geschriebenen oder so stark veränderten, daß vom Original unter 10 % übrig ist, haben einen BC Header. Mich persönlich stören Header nicht, eher andersrum - manchmal sucht man bei irgendwas, das man mal irgendwo runtergeladen hat, die Herkunft - und findet sie nicht. Das ist dann echt blöd, grad wenn das Ding dann auch noch einen Namen hat, der bei G**le 94 Drillionen Treffer bringt. Also ich finde schon, daß da ordentliche Header rein gehören.

Im Übrigen sind die Copyright Hinweise laut WB-Lizenz erst mal Pflicht. Für alles, was Ihr neu macht, nicht, für alles Übernommene schon.

Aber tatsächlich, Coding Guidelines sollten sein, allerdings möglichst einfach gehaltene. Wir haben das bei BC nicht streng reglementiert, ganz bewußt nicht, weil dann schon wieder die ersten abspringen, weil sie sich gegängelt fühlen. Bei einem Projekt wie Linux Kernel hat sowas einen ganz anderen Stellenwert als bei WB & Co.


Ich habe eine Amazon-Wishlist. wink Oder spende an das Projekt.
Ich kann, wenn ich will, aber wer will, dass ich muss, kann mich mal

Offline

#10 30.07.2015 10:20:40

cwsoft
Mitglied

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

@webbird: Nach meinem Verständniss der GNU GPL dürfen bestehende Copyright Hinweise in Quellcode nicht geändert werden.

Sprich ein Minimalheader wie folgt sollte GPL2 Konform sein:

[== PHP ==]
/**
 * WebsiteBaker Community Edition (WBCE)
 *
 * @copyright Ryan Djurovich (2004-2009)
 * @copyright Website Baker Org. e.V. (2009-2015)
 * @license GNU GPL2
 */

Wobei man den letzten Tag (@license) wohl auch noch weglassen könnte.

Gruss

Beitrag geändert von cwsoft (30.07.2015 10:21:01)


Account inactive since 2018/11/17.

Offline

#11 30.07.2015 10:22:26

webbird
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Nee, gerade der muß drin bleiben, und man muß den Text der GPL mitliefern.


Ich habe eine Amazon-Wishlist. wink Oder spende an das Projekt.
Ich kann, wenn ich will, aber wer will, dass ich muss, kann mich mal

Offline

#12 30.07.2015 15:41:13

cwsoft
Mitglied

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

@webbird: Na dann lassen wir die letzte Zeile drin (war mir nicht sicher). Der Text der GPL wird als LICENSE.md im Packet mitgeliefert.


Account inactive since 2018/11/17.

Offline

#13 30.07.2015 16:35:40

webbird
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Naja, immerhin ist der Header doch schon deutlich aufgeräumter.  big_smile

Edit: 100% sicher bin ich auch nicht, aber ich hab so im Hinterkopf, daß das drin sein muß. Die eine Zeile tut ja nich weh.


Ich habe eine Amazon-Wishlist. wink Oder spende an das Projekt.
Ich kann, wenn ich will, aber wer will, dass ich muss, kann mich mal

Offline

#14 18.08.2015 21:42:42

cwsoft
Mitglied

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Zum Thema Coding-Standards wurde auch an anderer Stelle etwas gepostet.

Generell fände ich es schön, wenn wir für neu erstellten Code einen gemeinsamen Nenner für die gröbsten Code-Stilvorgaben (Dateikodierung, Einrückung (TAB --> 4 x SPACE), Klammersetzung und Bennenung von Klassen, Funktions- bzw. Variablennamen) hätten.

Sollte nicht ZWANGHAFT sein, sondern uns die GEMEINSAME ZUSAMMENARBEIT erleichtern smile

Beitrag geändert von cwsoft (18.08.2015 21:47:14)


Account inactive since 2018/11/17.

Offline

#15 19.08.2015 18:46:58

norhei
Developer

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Auch hier , wäre für Tabs am Anfang der Zeile und Leerzeichen nach dem ersten Zeichen (Das war eine von DVs besseren Vorschlägen)

Offline

#16 07.01.2016 10:48:47

webbird
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Um das nochmal aufzugreifen - ich brauche jetzt mal eine klare Ansage weil ich Droplets überarbeite:

[== Undefiniert ==]
/**
 * WebsiteBaker Community Edition (WBCE)
 *
 * @copyright Ryan Djurovich (2004-2009)
 * @copyright Website Baker Org. e.V. (2009-2015)
 * @copyright wbce.org (since 2015)
 * @license GNU GPL2 (http://www.gnu.org/licenses/gpl.html)
 */

Ich habe eine Amazon-Wishlist. wink Oder spende an das Projekt.
Ich kann, wenn ich will, aber wer will, dass ich muss, kann mich mal

Offline

#17 07.01.2016 13:00:21

cwsoft
Mitglied

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Den aktuell gültigen Dateiheader kannst Du aus dem Lizenzabschnitt der README.md entnehmen.


Account inactive since 2018/11/17.

Offline

#18 07.01.2016 13:11:02

webbird
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Danke!


Ich habe eine Amazon-Wishlist. wink Oder spende an das Projekt.
Ich kann, wenn ich will, aber wer will, dass ich muss, kann mich mal

Offline

#19 08.01.2016 14:17:58

cwsoft
Mitglied

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

@webbird: bei Droplets würde ich noch Ruud und pcwacht als ursprüngliche Ideengeber mit in die Copyright Statements aufnehmen. Habe ich z.B. auch bei Stefeks Pagetree Beschleuniger im WBCE Core so gemacht. Bei Modulen sowieso. Rest passt wie es ist.

Beitrag geändert von cwsoft (08.01.2016 14:18:38)


Account inactive since 2018/11/17.

Offline

#20 08.01.2016 14:48:23

webbird
Administrator

Re: Coding Standards - oder wie gemeinsam am Core arbeiten?

Steht in der info.php, sollte reichen.


Ich habe eine Amazon-Wishlist. wink Oder spende an das Projekt.
Ich kann, wenn ich will, aber wer will, dass ich muss, kann mich mal

Offline

Fußzeile des Forums

up