Procesos de desarrollo y revisión de los complementos de NVDA
Gracias por tu interés en desarrollar y enviar tu complemento de NVDA para su distribución en la comunidad. Desde 2013, el sitio web de complementos de NVDA de la comunidad es el hogar de muchos paquetes de complementos creados por autores como tú.
El propósito de este documento es servir como guía acerca del funcionamiento de la revisión de la comunidad, expectativas, y proporcionar consejos eficaces para desarrollar complementos y revisarlos. Para más información sobre el desarrollo de complementos, lee la guía de desarrollo de complementos de NVDA.
Importante: al enviar tu complemento para su distribución en la comunidad, reconoces que cumplirás con el código de conducta de la comunidad de NVDA.
Los procesos generales de desarrollo y revisión de complementos son los siguientes:
Preparación
Para desarrollar un complemento, necesitas una copia de NVDA. Aunque las versiones estables funcionarán, recomendamos utilizar versiones beta o, si eres realmente aventurero, versiones alpha.
También tendrás que instalar Python 3.7 o posterior para probar la idea de tu complemento, y si utilizas la plantilla de complemento de la comunidad de NVDA, para empaquetar tu complemento. Además, necesitarás tener acceso a la aplicación para la que escribes el complemento, y software y hardware necesario para desarrollar complementos con controladores de síntesis de voz o pantallas Braille.
Por último, suscríbete a la lista de correo de complementos de NVDA para familiarizarte con la comunidad de complementos. El foro está diseñado para ayudarte a desarrollar tu complemento permitiendo que los usuarios te envíen retroalimentación. También se usa para facilitar la revisión de complementos y el anuncio de nuevas versiones.
Para más instrucciones, consulta las pautas.
Hacer que se revise un complemento
Si quieres publicar tu complemento en la comunidad de NVDA a través del sitio web de complementos, debe pasar al menos por una revisión. Primero, ten a mano un enlace público a la versión de desarrollo de tu complemento, tal como un enlace al instalador, un repositorio con control de versiones como GitHub, y demás. Esto sirve para que el revisor pueda descargar y probar tu complemento.
Una vez tengas el enlace de descarga a mano, envía un mensaje a la lista de complementos de NVDA solicitando una revisión del complemento. Debes incluir el nombre de tu complemento y una breve descripción sobre lo que hace. No olvides incluir el enlace público a tu complemento.
En cuanto se recibe una solicitud de revisión, un revisor (no el autor del complemento en cuestión) revisará tu complemento basándose en los siguientes criterios:
- Licencia y copyright: tu complemento debe estar licenciado de tal manera que sea compatible con la licencia GNU General Public License (GPL) 2 o posterior. Esto es obligatorio porque NVDA está bajo la licencia GNU GPL versión 2. Para garantizarlo, al principio de los archivos del complemento, incluye una breve cabecera de copyright y, si no estás seguro, pide consejo a la comunidad.
- Experiencia de usuario: mucha gente usará tu complemento, por lo que estará sujeto a pruebas de experiencia de usuario tales como instalación, compatibilidad con NVDA, interfaz gráfica y demás.
- Documentación: los usuarios aprenderán mucho sobre tu complemento con su documentación. Haz la documentación comprensible para ellos.
- Seguridad: ya que tu complemento se vuelve parte de NVDA al activarse, puede realizar operaciones como añadir o eliminar archivos, acceder a Internet, y leer y escribir claves del registro de Windows. La comunidad de complementos de NVDA se toma la seguridad de los complementos muy en serio.
Durante una revisión básica, el revisor puede aprobar el complemento para su distribución o sugerir cambios. Con frecuencia, las revisiones van acompañadas de comentarios relacionados con la experiencia de usuario y otros conceptos, así que tómate un momento para revisar estos comentarios. Una vez se apruebe el complemento, se pondrá en cola para su distribución en el sitio web de complementos de la comunidad.
Importante: incluso si el complemento supera otros criterios de revisión, si la licencia no es compatible con la GPL 2, el complemento no se aprobará.
Revisiones en profundidad
Además de la revisión básica (licencia y copyright, experiencia de usuario, documentación, seguridad), puedes solicitar a la comunidad de complementos revisiones en profundidad. Las revisiones en profundidad pueden incluir auditorías avanzadas como fallos de memoria, compatibilidad con versiones de desarrollo de NVDA, sugerencias de interfaz gráfica, estilo del código, conflictos en tiempo de ejecución con otros complementos, y problemas de compatibilidad con distintas versiones de Python. El complemento debe superar primero la revisión básica antes de que se puedan solicitar revisiones en profundidad.
Combinación con otros complementos
Si se determina que el complemento bajo revisión es similar a otro complemento, la comunidad puede pedir a su autor o autores que combinen sus complementos. Para ello, los miembros de la comunidad deben señalar semejanzas y diferencias entre los complementos candidatos. Si los autores de los complementos acuerdan que estos se pueden combinar, se debe registrar este hecho en una versión futura del complemento combinado.
Mantenimiento
Ahora que tu complemento ha sido revisado y aprobado, es hora de mantener el complemento. Según mantienes el complemento, recibirás comentarios de los usuarios y de otros autores de complementos. Responde a sus comentarios y mantén la comunicación.
Si utilizas control de versiones, podrías querer trabajar con varias ramas para desarrollar características independientes o sincronizar el complemento con el flujo de traducciones. La rama "master" debería considerarse como rama de desarrollo, adecuada para probar complementos antes de la publicación. Si utilizas el flujo de traducciones, la rama "stable" se usa para intercambiar contenido de traducciones y publicar el complemento.
En caso de que ya no seas capaz de mantener el complemento, envía un mensaje a la lista de complementos de NVDA buscando un nuevo responsable del mantenimiento. Cualquier miembro de la comunidad puede entonces ofrecerse voluntario para mantener el complemento. El nuevo encargado del mantenimiento se convierte en autor del mismo, sujeto a las reglas establecidas en este documento.
Publicación de una nueva versión de un complemento
De vez en cuando, publicarás versiones actualizadas del complemento para añadir nuevas características o corregir fallos. En algunos casos, publicarás un nuevo complemento para hacerlo compatible con versiones más recientes de NVDA.
Cuando estés listo para publicar la nueva versión, o poco después de hacerlo, envía un mensaje a la lista de complementos de NVDA para informar a la gente sobre la nueva versión. Proporciona la nueva versión y una descripción de lo que ha cambiado desde la versión anterior.
Si sientes que necesitas una revisión por parte de los revisores de la comunidad, házselo saber a la gente. Esto se aplica si necesitas hacer cambios relacionados con la licencia.
Eliminación de complementos
Si se descubre código dañino mientras se lista un complemento en el sitio web de complementos de la comunidad, este quedará sujeto a eliminación. El código dañino puede incluir la descarga de archivos sin permiso, añadir, renombrar o eliminar archivos fuera del ámbito del complemento sin permiso, ejecutar programas externos fuera del ámbito del complemento, y comprometer la funcionalidad de NVDA con intenciones maliciosas. Un caso especial es la inclusión de código incompatible con la GPL o partes de código bajo licencia propietaria sin permiso del autor del código.
Si se sospecha o se encuentra realmente código dañino, un miembro de la comunidad de NVDA debe informar por la lista de complementos sobre el problema. El informante debe proporcionar el nombre del complemento, versión, autor, y código dañino específico. Si la investigación de la comunidad determina que el código dañino existe, se debe contactar con el autor del complemento. El autor debe responder ante las evidencias encontradas por la comunidad y tomar acciones como reemplazar el código dañino, cambiar su licencia (sujeto de nuevo a revisión básica), o pedir a la comunidad que se elimine el complemento del sitio web de complementos. Si el autor no toma medidas, el complemento en cuestión se eliminará del sitio web de complementos de la comunidad.
Estado de antigüedad
A veces, se puede marcar un complemento como antiguo. Esto puede ocurrir si el complemento se vuelve incompatible con la versión más reciente de NVDA sin compatibilidad hacia atrás (por ejemplo, 2019.3). Esto también puede pasar si las funciones del complemento se integran en NVDA (por ejemplo, la cortina de pantalla) o se transfieren a otro complemento.
Si un complemento debería marcarse como antiguo, el autor del complemento o un miembro de la comunidad debe informar por la lista de complementos, preferiblemente el autor. El informante debe proporcionar el nombre del complemento, versión, y las razones por las que debería marcarse como antiguo, por ejemplo que sus funciones se han incorporado a NVDA. Con un acuerdo entre el autor del complemento y la comunidad, el complemento en cuestión se convertirá en un complemento antiguo.
Puede pasar lo contrario, y es que un complemento marcado como antiguo deje de serlo. Se debería seguir el mismo procedimiento que se ha descrito más arriba, indicando a la comunidad las razones para quitarle el estado de antiguo. Si la comunidad y el autor del complemento determinan que ya no es un complemento antiguo, se le retirará el estado de complemento antiguo. Se debe dar prioridad al autor del complemento para su mantenimiento, o un miembro de la comunidad puede ofrecerse como voluntario para mantenerlo.