Revisión de archivos de intercambio de archivosLa revisión de complementos/secuencias de comandos de otras personas lleva mucho tiempo (especialmente si hay algún problema). Un gran problema es cómo funcionan los complementos de File Exchange/JMP, pero es una discusión diferente. Algunas cosas para pensar:
- Deberíamos probar para definir algún tipo de esquema de lo que debe revisarse cuando se revisan los archivos de Intercambio de archivos?
- ¿Deberíamos tener algunas pautas para usuarios ¿Cuáles deben cumplirse antes de que los archivos puedan ser aceptados?
- ¿Debería haber instrucciones sobre cómo los usuarios pueden publicar sus archivos?
- Hacer públicos los pasos de los procesos de revisión para que los usuarios sepan qué se debe cumplir y qué se está revisando.
- También agregaría un descargo de responsabilidad a la sección Intercambio de archivos de que todos los complementos se usan bajo la responsabilidad del usuario ya que el proceso de revisión no captará todo.
Hay muchas cosas que arruinan su experiencia con JMP si instala o usa complementos. Cosas como Borrar Símbolos, jugar con los espacios de nombres, usar Salir/Salir y, en mi opinión, jugar con las Preferencias es lo más molesto.
A continuación hay una pequeña lista que me vino a la mente sobre cosas que no deberían permitirse:
- Sin contaminación del espacio de nombres (use here/window/box o espacios de nombres anónimos...)
- Sin símbolos claros/globales claros
- No tocar las preferencias del usuario a menos que sea el propósito del complemento
- No hay conexiones a servicios (solicitudes) fuera de JMP SIN que el usuario lo sepa claramente
- No Salir / Salir
- No se pueden agregar secuencias de comandos directamente al complemento/barra de herramientas, ya que es una pesadilla revisarlo. Todos los scripts deben estar en archivos .jsl que se instalan durante la instalación del complemento.
- Si se agrega un complemento a menús ya existentes además de Complementos, debe quedar claro que se trata de un complemento personalizado.
- Si instala la barra de herramientas, no se meta con las barras de herramientas existentes y agregue siempre las personalizadas.
- Evite los scripts de inicio y salida
- (No hay código encriptado que no se pueda revisar, lo que significa que se debe proporcionar la clave al revisor para verificar el código)
Re: Revisión de archivos de intercambio de archivosSi bien muchos de ellos suenan como las mejores prácticas, me preocupa que la comunidad de usuarios aquí no sea lo suficientemente grande como para admitir esas restricciones, lo que significa que muchos complementos o scripts nunca se enviarán.creo que podríamos pedir Sin embargo, a los usuarios cuáles de estas cosas están haciendo, y al menos dejar en claro lo que podría suceder si alguien usa un script. ¿Quizás algo en una plantilla de publicación nueva?
Re: Revisión de archivos de intercambio de archivosEn primer lugar, gracias por iniciar el debate sobre los complementos.
@jthi Estoy de acuerdo con todas tus afirmaciones. Sí, creo que deberíamos proporcionar un conjunto de pautas que deben cumplirse para enviar un complemento. Sí, debemos proporcionar una explicación del proceso de revisión. Si un usuario no está dispuesto a cumplir con las pautas o no está dispuesto a tomarse el tiempo para cumplir con las pautas, estoy de acuerdo con sacrificar la publicación de ese complemento. Preferiría desarrollar una biblioteca en la que, como resultado, un usuario tenga un mayor nivel de confianza en el complemento.
Ha proporcionado una lista excelente con la que comenzar las directrices. Puedo trabajar con nuestros escritores para desarrollar un artículo de conocimiento para las pautas y el proceso de revisión junto con un descargo de responsabilidad sobre el uso de cualquiera de los complementos proporcionados.
Como dijiste, revisar un complemento no es una tarea trivial. ¿Qué sugerencias tienes para revisar? ¿Es esta una tarea que ustedes (los superusuarios) harían (posiblemente además de cualquier miembro del personal de JMP que pueda reclutar)? ¿La revisión consiste en verificar solo las pautas o se deben tomar medidas adicionales? Interesado en escuchar otros pensamientos.
Los complementos son solo una parte del Intercambio de archivos. Lo que decidamos para esta biblioteca también puede aplicarse a los scripts y los datos de muestra.
Para 2023, esperamos comenzar a realizar una revisión más profunda de cada sección de la Comunidad para determinar la propiedad, el diseño, la funcionalidad, etc. Entonces, háganos saber qué mejoras cree que beneficiarían el Intercambio de archivos (o simplemente agregar -ins) para que podamos seguir debatiendo y construyendo nuestra hoja de ruta.
Gracias.
Re: Revisión de archivos de intercambio de archivoshe estado trabajando con @Wendy_Murphrey y @_jr para desarrollar un proceso utilizando dos complementos enviados recientemente: Barra de herramientas de selección rápida y Barra de herramientas del generador de gráficos.
Aquí hay algunas notas basadas en nuestras revisiones:
- Comenzó una plantilla para proporcionar más uniformidad entre los envíos y, con suerte, facilitar la búsqueda de información relevante sobre el complemento. No modificamos el contenido de la publicación original para alinearlo con la plantilla.
- Si bien instalamos y verificamos algunas funciones básicas como se indica en el artículo asociado, no las probamos. Creemos que las pruebas están más allá del alcance de un revisor.
- Escaneé el código para verificar que cumpliera con las pautas, es decir, modifica las preferencias del usuario, realiza llamadas al sistema operativo o al servicio externo, etc. El tiempo de revisión del código fue de alrededor de 15 minutos.
- A menos que sea absolutamente necesario, no más de 2 revisiones. La primera revisión puede ser más rigurosa y provocar que el complemento se devuelva al autor. La segunda revisión es para garantizar que se hayan corregido las principales infracciones encontradas en la primera revisión (y que no se hayan introducido nuevas). No queríamos que el proceso de envío de un complemento fuera demasiado pesado y desalentara la participación.
Estaremos documentando los pasos que tomamos para revisar el código como un recurso para otros revisores.
Nuestro próximo paso es tomar lo que hemos aprendido de esta iteración y aplicarlo a otra solicitud.
Si tiene alguna pregunta, por favor hágamelo saber. Gracias.
