Revisione dei file di scambio di fileLa revisione di componenti aggiuntivi/script di altre persone richiede molto tempo (soprattutto se ci sono problemi). Un grosso problema è come funzionano i componenti aggiuntivi di File Exchange/JMP, ma è una discussione diversa. Alcune cose da pensare:
- Dovremmo Tentativo per definire una sorta di schema cosa dovrebbe essere rivisto quando si esaminano i file di File Exchange?
- Dovremmo avere delle linee guida per utenti che devono essere rispettate prima che i file possano essere accettati?
- Dovrebbero esserci istruzioni su come gli utenti possono pubblicare i loro file?
- Rendere pubbliche le fasi del processo di revisione in modo che gli utenti sappiano cosa deve essere rispettato e cosa viene controllato.
- Aggiungerei anche una dichiarazione di non responsabilità alla sezione Scambio file secondo cui tutti i componenti aggiuntivi vengono utilizzati sotto la responsabilità del utente poiché il processo di revisione non prenderà tutto.
Ci sono molte cose che rovinano la tua esperienza con JMP se installi / usi componenti aggiuntivi. Cose come Clear Symbols, fare scherzi con gli spazi dei nomi, usare Esci/Esci e, a mio parere, i pasticci più fastidiosi con le Preferenze.
Di seguito è riportato un piccolo elenco che mi è venuto in mente su cose che non dovrebbero essere consentite:
- Nessun inquinamento dello spazio dei nomi (usare here/window/box o spazi dei nomi anonimi...)
- Nessun simbolo chiaro/globali chiari
- Non toccare le preferenze dell'utente a meno che non sia lo scopo del componente aggiuntivo
- Nessuna connessione a servizi (richieste) al di fuori di JMP SENZA che l'utente lo sappia chiaramente
- No Esci / Esci
- Non è possibile aggiungere script direttamente al componente aggiuntivo/barra degli strumenti in quanto è un incubo da rivedere. Tutti gli script devono trovarsi nei file .jsl che vengono installati durante l'installazione del componente aggiuntivo
- Se il componente aggiuntivo viene aggiunto a menu già esistenti oltre ai componenti aggiuntivi, è necessario chiarire che si tratta di un componente aggiuntivo personalizzato.
- Se si installa la barra degli strumenti, non modificare le barre degli strumenti esistenti e aggiungere sempre quelle personalizzate.
- Evita gli script di avvio e di uscita
- (Nessun codice crittografato che non può essere rivisto, il che significa che la chiave dovrebbe essere fornita al revisore per controllare il codice
Re: revisione dei file di scambio fileSebbene molte di queste sembrino best practice, sono preoccupato che la comunità di utenti qui non sia abbastanza grande da supportare tali restrizioni, il che significa che molti componenti aggiuntivi o script non verrebbero mai inviati.Penso che potremmo Chiedi utenti quali di queste cose stanno facendo, e almeno chiarisci cosa potrebbe accadere se qualcuno usa uno script. Forse qualcosa in un modello di nuovo post?
Re: revisione dei file di scambio fileInnanzitutto, grazie per aver avviato la discussione sui componenti aggiuntivi.
@jthi Sono d'accordo con tutte le tue affermazioni. Sì, penso che dovremmo fornire una serie di linee guida che devono essere soddisfatte per inviare un componente aggiuntivo. Sì, dovremmo fornire una spiegazione del processo di revisione. Se un utente non è disposto a rispettare le linee guida o non è disposto a prendersi il tempo per soddisfare le linee guida, mi va bene sacrificare la pubblicazione di quel componente aggiuntivo. Di conseguenza, preferirei sviluppare una libreria in cui un utente abbia un livello di fiducia più elevato nel componente aggiuntivo.
Hai fornito un eccellente elenco con cui iniziare le linee guida. Posso lavorare con i nostri autori per sviluppare un articolo di conoscenza per le linee guida e il processo di revisione insieme a una dichiarazione di non responsabilità sull'utilizzo di uno qualsiasi dei componenti aggiuntivi forniti.
Come hai affermato, la revisione di un componente aggiuntivo è un'attività non banale. Quali suggerimenti hai per la revisione? È un compito che voi (i Super User) fareste (possibilmente in aggiunta a qualsiasi membro dello staff di JMP che posso reclutare)? La revisione consiste nel verificare solo le linee guida o dovrebbero essere intraprese ulteriori misure? Interessato a sentire altri pensieri.
I componenti aggiuntivi sono solo una parte dello scambio di file. Ciò che decidiamo per questa libreria può essere applicato anche agli script e ai dati di esempio.
Per il 2023, speriamo di iniziare a fare una revisione più approfondita di ogni sezione della community per determinare proprietà, design, funzionalità, ecc. -ins) in modo da poter discutere ulteriormente e integrare la nostra tabella di marcia.
Grazie.
Re: revisione dei file di scambio fileho lavorato con @Wendy_Murphrey E @_jr per sviluppare un processo utilizzando due componenti aggiuntivi inviati di recente: Barra degli strumenti Selezione rapida E Barra degli strumenti del Costruttore di grafici.
Ecco alcune note basate sulle nostre recensioni:
- Avviato un modello per fornire maggiore uniformità tra gli invii e, si spera, rendere più facile trovare informazioni rilevanti sul componente aggiuntivo. Non abbiamo modificato il contenuto del post originale per allinearlo al modello.
- Mentre abbiamo installato e verificato alcune funzionalità di base come indicato nell'articolo associato, non abbiamo testato. Riteniamo che i test vadano oltre lo scopo di un revisore.
- Ha scansionato il codice per verificare che rispettasse le linee guida, ovvero modifica le preferenze dell'utente, effettua chiamate al sistema operativo o al servizio esterno, ecc. Il tempo per la revisione del codice è stato di circa 15 minuti.
- A meno che non sia assolutamente necessario, non più di 2 recensioni. La prima revisione potrebbe essere più rigorosa e comportare il respingimento del componente aggiuntivo all'autore. La seconda revisione serve a garantire che tutte le violazioni principali riscontrate nella prima revisione siano state corrette (e non ne siano state introdotte di nuove). Non volevamo rendere il processo di presentazione di un add-in troppo gravoso e scoraggiare la partecipazione.
Documenteremo i passaggi che abbiamo intrapreso nella revisione del codice come risorsa per altri revisori.
Il nostro prossimo passo è prendere ciò che abbiamo imparato da questa iterazione e applicarlo a un'altra richiesta.
Se avete domande, fatemelo sapere. Grazie.
