Überprüfen von DateiaustauschdateienDas Überprüfen von Add-Ins/Skripten anderer Personen dauert sehr lange (insbesondere, wenn es Probleme gibt). Ein großes Problem ist die Funktionsweise von File Exchange/JMP-Add-Ins, aber das ist eine andere Diskussion. Einige Dinge zum Nachdenken:
- Sollten wir Versuchen eine Art Gliederung zu definieren, was beim Durchsuchen von Dateiaustauschdateien überprüft werden sollte?
- Sollten wir einige Richtlinien dazu haben Benutzer welche müssen erfüllt sein, bevor die Akten angenommen werden können?
- Sollte es Anweisungen geben, wie Benutzer ihre Dateien veröffentlichen können?
- Machen Sie die Schritte des Überprüfungsprozesses öffentlich, damit die Benutzer wissen, was eingehalten werden muss und was überprüft wird.
- Ich würde auch einen Haftungsausschluss zum Abschnitt Dateiaustausch hinzufügen, dass alle Add-Ins auf Verantwortung des verwendet werden Benutzer da der Überprüfungsprozess nicht alles erfasst.
Es gibt viele Dinge, die Ihre JMP-Erfahrung ruinieren, wenn Sie Add-Ins installieren/verwenden. Dinge wie Clear Symbols, das Herumspielen mit Namespaces, die Verwendung von Quit/Exit und meiner Meinung nach das nervigste Herumspielen mit den Einstellungen.
Unten ist eine kleine Liste, die mir über Dinge in den Sinn kam, die nicht erlaubt sein sollten:
- Keine Namespace-Verschmutzung (benutze hier/window/box oder anonyme Namespaces...)
- Keine klaren Symbole/klare Globals
- Kein Berühren der Benutzereinstellungen, es sei denn, dies ist der Zweck des Add-Ins
- Keine Verbindungen zu Diensten (Anfragen) außerhalb von JMP, OHNE dass der Benutzer dies eindeutig weiß
- Kein Beenden / Beenden
- Kein direktes Hinzufügen von Skripten zum Add-In/der Symbolleiste, da die Überprüfung ein Albtraum ist. Alle Skripts sollten sich in .jsl-Dateien befinden, die während der Add-In-Installation installiert werden
- Wenn Add-Ins neben Add-Ins zu bereits bestehenden Menüs hinzugefügt werden, muss deutlich gemacht werden, dass es sich um ein benutzerdefiniertes Add-In handelt.
- Wenn Sie die Symbolleiste installieren, spielen Sie nicht mit den vorhandenen Symbolleisten herum und fügen Sie immer benutzerdefinierte hinzu.
- Vermeiden Sie Start- und Exit-Skripte
- (Kein verschlüsselter Code, der nicht überprüft werden kann, was bedeutet, dass der Schlüssel dem Prüfer zur Verfügung gestellt werden müsste, um den Code zu überprüfen
Betreff: Überprüfen von DateiaustauschdateienWährend viele davon nach Best Practices klingen, mache ich mir Sorgen, dass die Benutzergemeinschaft hier nicht groß genug ist, um diese Einschränkungen zu unterstützen, was bedeutet, dass viele Add-Ins oder Skripte niemals eingereicht würden.Ich denke, wir könnten Fragen Benutzern, welche dieser Dinge sie tun, und machen Sie zumindest deutlich, was passieren kann, wenn jemand ein Skript verwendet. Vielleicht etwas in einem New-Post-Template?
Betreff: Überprüfen von DateiaustauschdateienZunächst vielen Dank, dass Sie die Diskussion über Add-Ins begonnen haben.
@jthi Ich stimme allen Ihren Aussagen zu. Ja, ich denke, wir sollten eine Reihe von Richtlinien bereitstellen, die erfüllt werden müssen, um ein Add-In einzureichen. Ja, wir sollten den Überprüfungsprozess erläutern. Wenn ein Benutzer nicht bereit ist, sich an die Richtlinien zu halten oder sich nicht die Zeit nehmen möchte, die Richtlinien zu erfüllen, kann ich die Veröffentlichung dieses Add-Ins opfern. Ich würde lieber eine Bibliothek entwickeln, bei der ein Benutzer dem Add-In dadurch mehr Vertrauen entgegenbringt.
Sie haben eine ausgezeichnete Liste erstellt, mit der Sie die Richtlinien beginnen können. Ich kann mit unseren Autoren zusammenarbeiten, um einen Wissensartikel für die Richtlinien und den Überprüfungsprozess zusammen mit einem Haftungsausschluss zur Verwendung eines der bereitgestellten Add-Ins zu entwickeln.
Wie Sie bereits sagten, ist die Überprüfung eines Add-Ins keine triviale Aufgabe. Welche Vorschläge haben Sie zur Überprüfung? Ist dies eine Aufgabe, die Sie (die Superuser) übernehmen würden (möglicherweise zusätzlich zu JMP-Mitarbeitern, die ich rekrutieren kann)? Besteht die Überprüfung nur in der Überprüfung der Leitlinien oder sollten zusätzliche Schritte unternommen werden? Interessiert, andere Gedanken zu hören.
Add-Ins sind nur ein Teil des Dateiaustauschs. Was wir für diese Bibliothek entschieden haben, kann auch für Skripte und Beispieldaten gelten.
Für 2023 hoffen wir, mit einer eingehenderen Überprüfung jedes Abschnitts der Community beginnen zu können, um Eigentum, Design, Funktionalität usw -ins), damit wir unsere Roadmap weiter diskutieren und einbauen können.
Vielen Dank.
Betreff: Überprüfen von DateiaustauschdateienIch habe mit gearbeitet @Wendy_Murphrey Und @_jr um einen Prozess mit zwei kürzlich eingereichten Add-Ins zu entwickeln: QuickSelect-Symbolleiste Und Graph Builder-Symbolleiste.
Hier sind ein paar Anmerkungen basierend auf unseren Bewertungen:
- Es wurde eine Vorlage gestartet, um für mehr Einheitlichkeit bei den Einreichungen zu sorgen und es hoffentlich einfacher zu machen, relevante Informationen über das Add-In zu finden. Wir haben den Inhalt des ursprünglichen Beitrags nicht geändert, um ihn an die Vorlage anzupassen.
- Obwohl wir einige grundlegende Funktionen wie im zugehörigen Artikel angegeben installiert und überprüft haben, haben wir sie nicht getestet. Wir sind der Meinung, dass das Testen über den Rahmen eines Rezensenten hinausgeht.
- Der Code wurde gescannt, um zu überprüfen, ob er den Richtlinien entspricht, dh ändert er die Benutzereinstellungen, führt er Aufrufe an das Betriebssystem oder einen externen Dienst aus usw. Die Zeit für die Codeüberprüfung betrug etwa 15 Minuten.
- Sofern nicht unbedingt erforderlich, nicht mehr als 2 Bewertungen. Die erste Überprüfung kann strenger sein und dazu führen, dass das Add-In an den Autor zurückgesendet wird. Die zweite Überprüfung soll sicherstellen, dass alle größeren Verstöße, die in der ersten Überprüfung festgestellt wurden, korrigiert wurden (und keine neuen eingeführt wurden). Wir wollten den Vorgang des Einreichens eines Add-Ins nicht zu sehr belasten und von der Teilnahme abhalten.
Wir werden die Schritte, die wir bei der Überprüfung des Codes unternommen haben, als Ressource für andere Prüfer dokumentieren.
Unser nächster Schritt besteht darin, das, was wir aus dieser Iteration gelernt haben, auf eine andere Anfrage anzuwenden.
Wenn Sie Fragen haben, lassen Sie es mich bitte wissen. Danke.
