Erhalten Sie eine Peer Review für mein neues Plugin?

8

Was ist der beste Weg, um einen erfahrenen WordPress-Entwickler dazu zu bringen, sich mein Plugin anzusehen und konstruktive Kritik zu üben? Ich habe Code geschrieben, um einige meiner Fragen auf dieser Site zu lösen, und ich denke, sie könnten auch für andere nützlich sein. Da sie jedoch von meinen ersten öffentlichen WordPress-Plugins stammen und ich viele nicht so gute Beispiele im öffentlichen WordPress-Verzeichnis gesehen habe, möchte ich wissen, "wo ich stehe" und wie ich meine Plugins verbessern kann. Ich habe die Liste der Best Practices gelesen und muss noch einige davon anwenden, möchte aber auch eine Antwort auf die allgemeinere Frage "Ist dies ein guter Weg, um dieses Problem zu lösen?"

Ich habe gerade die entsprechende Diskussion überwp-hackers erneut gelesen (ich wusste nicht, dass die Teilnehmer auch so an dieser Site beteiligt waren und dass die Frage nach den "Best Practices" ein direktes Ergebnis davon ist). Ich bin nicht sicher, ob meine Bedürfnisse durch ein solches System abgedeckt werden, und ich stimme den Bedenken von Paul zu :

Als ich letzte Woche die ursprünglichen Kommentare zu diesem Thread las, dachte ich, dass der Zweck darin bestand, einen Peer-Review-Prozess zusammenzustellen, bei dem Plugin-Entwickler anderen Plugin-Entwicklern Ratschläge zur Überprüfung ihres Codes geben können. Ich habe diesen Rat ursprünglich wie folgt verstanden: "Nun, Ihr Code funktioniert, aber diese von Ihnen geschriebenen Routinen wären besser geeignet, wenn Sie sich nur in diesen WP-Filter einbinden und diese Technik ausprobieren würden (siehe xxx-Plugin als Beispiel). ". Das Ziel, das ich dachte, war es, das Wissen über die Entwicklung von WP-Plugins zu teilen und jeden mittelmäßigen Plugin-Entwickler zu einem besseren Entwickler zu machen. Wie ich.

Dies wäre ein anderer Umfang als eine Punkt-für-Punkt-Überprüfung der Checkliste, es wäre eher eine "Mentorschaft". Es scheint, dass es viele Menschen gibt, die dazu bereit sind, und (noch besser) viele von ihnen nehmen hier auf dieser Website teil. Wie können wir also all diese Energie in etwas Konkretes umwandeln?

Mein aktuelles Beispiel sind drei Plugins, die ich geschrieben habe, um mein Problem mit der Bildgröße zu lösen . Ich habe zu jedem Plugin lange einleitende Kommentare geschrieben, was (ich hoffe) es einfacher macht, meine Absichten zu verstehen, ohne den vollständigen Code zu lesen. Kann ich noch etwas tun, um es anderen leichter zu machen, es sich anzusehen? Bitte ignorieren Sie meine aktuelle konkrete Anfrage. Es ist nicht nur zu früh für sie, sondern ich habe meine Meinung geändert und möchte die allgemeine Diskussion mit meiner spezifischen Situation nicht verderben.

plugin-development customization Jan Fabry
quelle
Es scheint hier einige erfahrene Plugin-Codierer zu geben. Warum also nicht hier fragen?
Raphael
2
@ Raphael: Ich habe es gerade getan, nicht wahr? :-) Aber ich wollte meine Frage verallgemeinern, damit andere sie auch nützlich finden. Vielleicht gibt es einige allgemeine Richtlinien, die man befolgen kann, um die Überprüfung des Plugins zu vereinfachen.
Jan Fabry
4 Jahre später ... haben Sie jemals diese Plugins veröffentlicht? Die Kernpunkte deuten darauf hin, dass sie noch auf halbem Weg sind, aber es scheint immer noch eine gute Idee zu sein.
Moralida
@moraleida Google ist dein Freund - gist.github.com/janfabry
patrickzdb

Antworten:

4

Der einfachste Weg ist ein zweistufiger Ansatz:

  1. Geben Sie Ihr Plug-In für die Öffentlichkeit frei. Sobald es live ist, erhalten Sie neben Entwicklern auch Feedback von Endbenutzern. Wenn Sie möchten, veröffentlichen Sie es als "Beta" -Version und betonen Sie dies in der Readme-Datei.
  2. Fragen. Überall gibt es erfahrene WordPress-Entwickler: hier, auf der WP-Hackers-Liste, bei WordPress-Jobs , bei @wordpress auf Twitter usw. Es geht nur darum, Ihr Plug-In rauszuwerfen und um Feedback zu bitten.

Befolgen Sie im Allgemeinen die gleichen Schritte, als würden Sie einen Core-Patch von einem Entwickler betrachten lassen:

  • Schreib es
  • Dokumentieren Sie es
  • Wenden Sie sich an einen Entwickler (entweder über einen der oben genannten Kanäle oder direkt, wenn Sie können) und bitten Sie um Feedback

Was die Umwandlung der Art von "Mentoring" an dieser Stelle in etwas Konkreteres angeht, wäre dies ein organischer Prozess. Wie Sie bereits erwähnt haben, scheinen die Bemühungen, eine Art Plug-In-Überprüfungsprozess zu erstellen, bevor tatsächlich etwas überprüft wird, ins Stocken geraten zu sein. Die einzige Möglichkeit, etwas in Gang zu bringen, besteht darin, tatsächlich damit zu beginnen. Sprechen Sie also nicht nur darüber, einen erfahrenen Entwickler zu finden und Feedback zu erhalten, sondern gehen Sie hinaus, finden Sie einen, holen Sie sich Ihr Feedback und schreiben Sie auf, wie der Prozess verlaufen ist.

Dann kann es mit zukünftigen Plug-Ins und zukünftigen Entwicklern wiederholt werden. Aber du musst irgendwo anfangen ...

EAMann
quelle
Danke für die Antwort. Eine Sache, die mich davon abgehalten hat, Sie, Mike oder andere hochkarätige Mitwirkende hier direkt zu fragen, ist, dass ich Ihnen nichts aufzwingen und Sie "zwingen" möchte, etwas zu tun, was Sie lieber nicht tun würden, aber zu höflich sind Ablehnen. Und es könnte besser sein, ein Feedback zu erhalten, bevor ich das Plugin veröffentliche, um mich und seine Benutzer vor möglichen Dummheiten zu bewahren.
Jan Fabry
1. Hat bei mir nicht funktioniert. Ich hatte einige hundert Downloads, aber nicht einmal eine einzige Abstimmung auf wordpress.org.
Raphael
@ Raphael Votes auf WordPress.org sind zunächst kein echtes Feedback. Die Tatsache, dass Sie keine Beschwerden erhalten oder keine Fehlerberichte erhalten haben, bedeutet, dass dies höchstwahrscheinlich funktioniert und Ihre Endbenutzer zufrieden sind. Jetzt, da es sich im Repository befindet, ist es für Entwickler einfacher, die Quelle abzurufen und anzuzeigen. An dieser Stelle sollten Sie mit Schritt 2 fortfahren und einen erfahrenen Entwickler bitten , einen Blick darauf zu werfen und Feedback zu geben.
EAMann
1

Nach einem kurzen Blick auf https://gist.github.com/675437 sah ich einige kleinere Punkte, hauptsächlich in Bezug auf die Lesbarkeit:

  • Schreiben Sie eine gute Codedokumentation: Docblocks… und Inline-Kommentare, wenn etwas nicht absolut klar ist.
  • Teilen Sie lange Funktionen in kürzere separate Funktionen auf. Sie sind leichter zu lesen und in den Kommentaren der Rezensenten zu behandeln.
  • Richten Sie Ihre Zuweisungsoperatoren aus und fügen Sie Leerzeichen zwischen Klammern ein.
  • 80 Zeichen Zeilenlänge bitte! Eclipse kann immer noch keine langen Zeilen umbrechen. :(
  • Halten Sie Ihren Code »links«, speichern Sie Einrückungen. Anstatt:

.  

public function checkUrl()
{
    if (is_404()) {
        // code
    }
}

… schreiben …

public function checkUrl()
{
    if ( ! is_404() ) {
        return;
    }
    // code
}

Ich habe gerade heute Abend ein neues Plugin geschrieben… und ich habe mich gefragt, ob ich genau Ihre Frage stellen darf. Gutes Timing. :) :)

Fuxia
quelle
Vielen Dank für Ihre ersten Kommentare. Vielleicht war ich etwas zu früh, da ich tatsächlich eine gründliche Bearbeitung vornehmen muss, um den Code mit den Codierungsstandards in Einklang zu bringen, damit ich mich leichter auf den Inhalt konzentrieren kann. Ein guter Punkt zur Regel "Früh abreisen, um Einrückungen zu speichern", aber ich gehe davon aus, dass die zusätzlichen 4 Leerzeichen in jeder Zeile Ihres zweiten Beispiels unbeabsichtigt sind.
Jan Fabry
Ähm, ja, Markdown hat die Formatierung nach der Liste entstellt. Ich werde es reparieren.
Fuxia
Vielen Dank für Ihre Kommentare, aber ich habe die ursprüngliche Diskussion auf der Liste der wp-Hacker erneut gelesen und beschlossen, den Umfang zu erweitern, um meine spezifische Anfrage aus der Frage zu entfernen. Dies bedeutet, dass Ihre Antwort nicht mehr so ​​passend ist. Vielleicht möchten Sie sie löschen.
Jan Fabry
0

Ich musste nur an Appscan denken: http://www01.ibm.com/software/rational/products/appscan/source/ ; http://www-01.ibm.com/software/rational/products/appscan/source/features/ Testversion der Light-Version: http://www-01.ibm.com/software/awdtools/appscan/express/

Dies kann PHP tun und man kann zusätzliche Regeln einfügen, um nach Dingen zu suchen. Auf diese Weise kann ein Teil automatisiert werden (wie einige Best Practices wie in der Antwort von toscho), es kann nach Sicherheit, Codierungsstandards, Optimierungen usw. suchen.

Ich sage nur: Wenn ein Werkzeug 80% prüfen kann, sind die 20% für die manuellen Prüfungen für einen Guru geringer. Es wäre auch hilfreich, Compliance-Berichte für die Verwendung eines Plugins in einem großen Unternehmen zu erstellen, das solche Anforderungen an zusätzlichen Code stellt.

Wir automatisieren Dinge für andere Menschen. Warum also nicht für uns selbst?

Edelwasser
quelle