Ya sea que recién te hayas unido a nosotros como supervisor, seas un responsable de mantenimiento experimentado de p5.js, o estés en algún punto intermedio, esta guía contiene información, así como consejos y trucos que te ayudarán a contribuir de manera efectiva a p5.js. La mayor parte de lo que se escribe aquí son pautas a menos que se indique lo contrario, lo que significa que puedes adaptar las prácticas mostradas aquí para que se ajusten a tu flujo de trabajo.
Tabla de Contenidos
Issues
Alentamos a la mayoría de las contribuciones de código fuente a comenzar con un issue, y como tal, los issues son el lugar donde la mayoría de las discusiones tendrán lugar. Los pasos a seguir al revisar un issue dependerán del tipo de issue que sea. El repositorio utiliza Plantillas de issues de GitHub, para organizar mejor los diferentes tipos de issues y alentar a los autores de issues a proporcionar toda la información relevante sobre sus issues. El primer paso al revisar el issue a menudo será revisar la plantilla completada y determinar si necesita información adicional por ejemplo, porque algunos campos no se completaron o se utilizó la plantilla incorrecta.
Informe de Errores
Los issues de informes de errores deberían utilizar la plantilla de Issue “Found a bug”. El siguiente flujo de trabajo es típico para abordar los informes de errores:
- Replicar el error
- El objetivo de la plantilla es proporcionar suficiente información para que un revisor intente replicar el error en cuestión.
- Si el error reportado no es relevante para el repositorio en el que se abrió (p5.js, p5.js-website, u otro):
- Transfiera el issue al repositorio relevante si tiene acceso a él.
- De lo contrario, deje un comentario sobre dónde debería presentarse el informe de error (con un enlace directo proporcionado) y cierre el issue.
- El primer paso para revisar un informe de error es verificar si se proporciona suficiente información para replicar el error, y si es así, se debe intentar replicar el error según lo descrito.
- Si el error se puede replicar:
- Puede ser necesario realizar alguna discusión para determinar la mejor manera de solucionar un error particular. Puede ser necesario realizar alguna discusión para determinar la mejor manera de solucionar un error particular. A veces, puede ser directo;otras veces, puede ser complicado. Por favor, consulte los principios de diseño de p5.js al tomar esta decisión caso por caso.
- Si el autor del issue indicó en el issue que está dispuesto a contribuir con una solución:
- Apruebe el issue para su solución por parte del autor del issue dejando un comentario y asignándoles el issue. Utilice el botón de engranaje en el lado derecho junto a “Assignee”.
- Si el autor del issue no desea contribuir con una solución:
- Deje un comentario reconociendo que el error se puede replicar.
- Intente solucionarlo usted mismo o agregue la etiqueta
help wanted
para señalar que es un issue que necesita solución.
- Si el error no se puede replicar:
- Solicite información adicional si aún no se ha proporcionado en la plantilla (versión de p5.js, versión del navegador, versión del sistema operativo, etc).
- Si su entorno de prueba difiere de lo que se informa en el issue (por ejemplo,un navegador o sistema operativo diferente):
- Deje un comentario diciendo que no puede replicar en su entorno específico.
- Agregue una etiqueta
help wanted
al issue incidente y pida a alguien más con la configuración especificada en el issue que intente replicar el error.
- A veces, los bugs (errores) solo ocurren al usar el editor web y no al probar localmente. En este caso, el issue debería ser redirigido al repositorio del editor web.
- Si la replicación es posible más tarde, regrese al paso 2.
- Si el error se origina en el código que el usuario proporcionó en el informe de error y no en el comportamiento de p5.js:
Solicitud de Funcionalidades
Los issues para solicitar funcionalidades deberían utilizar la plantilla “New Feature Request”. El siguiente flujo de trabajo es típico para abordar las solicitudes de función:
- Como parte del compromiso de p5.js de aumentar el acceso, una solicitud de función debe justificar cómo aumenta el acceso de p5.js a comunidades que históricamente han sido marginadas en el campo. Más detalles están disponibles aquí.
- Si una solicitud de funcionalidad no tiene suficientemente completado el campo “Increasing Access” (“Aumento de Acceso”), puedes preguntar al autor del issue cómo la funcionalidad aumenta el acceso.
- La declaración de acceso de una funcionalidad puede ser proporcionada por un miembro diferente de la comunidad, incluidos los revisores de issue.
- Una nueva solicitud de funcionalidad puede ser evaluada para su inclusión en base a los siguientes criterios:
- ¿La función encaja en el alcance del proyecto y los principios de diseño principios de diseño de p5.js?
- Por ejemplo, una solicitud para agregar una nueva forma primitiva de dibujo puede ser considerada, pero una solicitud para adoptar un protocolo de Internet de las cosas basado en el navegador probablemente estará fuera de alcance.
- En general, el alcance de p5.js debería ser relativamente estrecho para evitar un exceso de características poco utilizadas.
- Si una función no encaja en el alcance de p5.js, sugiere al autor del issue que implemente la función como una biblioteca complementaria.
- Si no está claro si encaja o no, puede ser una buena idea sugerir hacer una biblioteca complementaria como una prueba de concepto. Esto ayuda a dar a los usuarios una forma de usar la funcionalidad, proporciona un ejemplo mucho más concreto de su uso e importancia, y no necesariamente necesita ser una solución tan completa como una función completamente integrada. Puede integrarse en el núcleo de p5.js más adelante si corresponde.
- ¿Es probable que la funcionalidad propuesta cause un cambio incompatible?
- ¿Entrará en conflicto con las funcionalidades y variables existentes de p5.js?
- ¿Entrará en conflicto con los sketches (bocetos) típicos ya escritos para p5.js?
- Las funcionalidades que probablemente causen conflictos, como las mencionadas anteriormente, se consideran cambios incompatibles. Sin un Lanzamiento de versión mayor,no deberíamos realizar cambios incompatibles en p5.js.
- ¿Se puede lograr la nueva función propuesta utilizando las funcionalidades existentes ya en p5.js,código JavaScript nativo relativamente simple, o bibliotecas existentes fáciles de usar?
- Por ejemplo, en lugar de proporcionar una función de p5.js para unir una matriz de cadenas como
join(["Hello","world!"])
, debería preferirse el JavaScript nativo["Hello","world!"].join()
.
- Por ejemplo, en lugar de proporcionar una función de p5.js para unir una matriz de cadenas como
- ¿La función encaja en el alcance del proyecto y los principios de diseño principios de diseño de p5.js?
- Si el requisito de acceso y otras consideraciones han sido cumplidas, al menos dos supervisores o responsables de mantenimiento deben aprobar la nueva solicitud de función antes de que comience el trabajo hacia una PR. El proceso de revisión de pull request para nuevas funcionalidades está documentado a continuación.
Mejora de funcionalidades
Las solicitudes de issues de mejora de función deberían utilizar la plantilla de incidentes de “Existing Feature Enhancement” (Mejora de Funcionalidades Existentes). El proceso es muy similar a las solicitudes de nuevas funcionalidades. La diferencia entre una new feature request (solicitud de nueva funcionalidad) y una feature request (Mejora de Funcionalidad) puede ser confusa a veces. La mejora de función principalmente trata sobre las funcionalidades existentes de p5.js, mientras que una solicitud de nueva función podría estar solicitando la adición de funcionalidades completamente nuevas.
- Similar a las solicitudes de nuevas funcionalidades, las mejoras de función solo deben ser aceptadas si aumentan el acceso a p5.js. Por favor, consulta el punto 1 de la sección anterior.
- Los criterios de inclusión para las mejoras de función son similares a los de las solicitudes de nuevas funcionalidades, pero se debe prestar especial atención a los posibles cambios incompatibles.
- Si se están modificando funcionalidades existentes, todas las firmas de funcionalidades válidas y documentadas previamente deben comportarse de la misma manera.
- Las mejoras de funcionalidades deben ser aprobadas por al menos un supervisor o responsable de mantenimiento antes de que comience el trabajo hacia una pull request. El proceso de revisión de pull request para mejoras de funcionalidades está documentado a continuación.
Discusión
Este tipo de issue tiene una plantilla mínima de discusión y debería ser utilizada para recopilar comentarios y retroalimentaciones sobre un tema en general antes de consolidarlo en algo más específico, como una solicitud de función. Estos issues de discusión pueden cerrarse cuando finaliza la conversación y se han creado los issues más específicos resultantes:
- Si se abre un issue como una discusión pero debería ser, por ejemplo, un bug report (informe de error), se debe aplicar la etiqueta correcta y quitar la etiqueta de “discussión”. Además, se debe solicitar información adicional sobre el error al autor si aún no se ha incluido.
- Si se abre un issue como una discusión pero no es relevante para la contribución de código fuente o de otra manera relevante para los repositorios de GitHub, el proceso de contribución o la comunidad de contribución, deberían ser redirigidos al foro o a Discord y el issue cerrado.
- Si es relevante, se deben agregar etiquetas adicionales a los issues de discusión para señalar aún más qué tipo de discusión es con solo mirarla.
Pull Requests
Casi todas las contribuciones de código a los repositorios de p5.js se realizan a través de Pull Request. Los supervisores y los responsables de mantenimiento pueden tener push access (acceso de escritura) a los repositorios, pero aún se les anima a seguir el mismo proceso de issue > pull request > proceso de revisión al contribuir con código. Aquí están los pasos para revisar una pull request:
- La plantilla de pull request se puede encontrar Aquî.
- Casi todas las solicitudes de pull requests deben tener issues asociados abiertos y discutidos primero, lo que significa que los”flujos de trabajo de los issues mås relevantes deben haber sido seguidos primero antes de que una pull request sea revisada por cualquier supervisor o responsable de mantenimiento.
- Las únicas instancias donde esto no se aplica son correcciones muy menores de errores tipográficos, las cuales no requieren un issue abierto y pueden ser fusionadas por cualquier persona con acceso para aplicar merge (fusionar) al repositorio, incluso si no son supervisores de una área en particular.
- Si bien esta excepción existe, la aplicaremos en la práctica solo mientras se siga alentando a los contribuyentes a abrir nuevos issues primero. En otras palabras, si tienes dudas sobre si esta excepción se aplica, simplemente abre un issue de todos modos.
- Si una “pull request”no resuelve completamente el issue referenciado, puedes editar la publicación original y cambiar “Resolves #OOOO” a “Addresses #OOOO” para que no cierre automáticamente el issue original cuando la pull request aplique merge (se fusione).
Correción Sencilla
Correcciones simples, como la corrección de un pequeño error tipográfico, pueden fusionarse directamente por cualquier persona con acceso para fusionar. Después, revisa la pestaña “Files Changed” de pull request para asegurarte de que la prueba automatizada de integración continua (CI) haya pasado.
Corrección de Error
- Bug fixes (Corrección de errores) deberían ser revisado por el supervisor del área relevante, idealmente el mismo que aprobó el issue referenciado para su corrección.
- La pestaña “Files Changed” de la pull request se puede utilizar para revisar inicialmente si el fix (la ccorrección) se implementa según lo descrito en la discusión del issue.
- La pull request Debería ser probada localmente siempre que sea posible y relevante. El GitHub CLI puede ayudar a agilizar parte del proceso. Ver más abajo en Consejos y trucos.
- La Corrección debe abordar suficientemente el issue original.
- La Corrección no debe cambiar ningún comportamiento existente a menos que se acuerde en el issue original.
- La Corrección no debe tener un impacto significativo en el rendimiento de p5.js.
- La Corrección no debe tener ningún impacto en la accesibilidad de p5.js.
- La Corrección debe utilizar el estándar moderno de codificación en JavaScript.
- La Corrección debe pasar todas las pruebas automatizadas e incluir nuevas pruebas (tests) si son relevantes.
- Si se requieren cambios adicionales, se deben agregar comentarios en línea a las líneas relevantes según se describió anteriormente aquí.
- Un bloque de sugerencias también puede ser usado para sugerir cambios específicos:
- Si se requieren múltiples cambios, no agregues comentarios de una sola línea muchas veces. En su lugar, sigue el procedimiento documentado aquí para hacer comentarios de varias líneas y una sola solicitud de cambios (change request).
- Si los comentarios en línea son solo para aclaraciones o discusión, elige “Comment” en lugar de “Request changes”:
- Un bloque de sugerencias también puede ser usado para sugerir cambios específicos:
- Una vez que la pull request haya sido revisada y no se requieran cambios adicionales, un supervisor puede marcar la pull request como “Aprobada” eligiendo la opción “Approve” en el paso anterior, con o sin comentarios adicionales. El supervisor puede luego solicitar una revisión adicional por otro supervisor o responsable de mantenimiento si lo desea, fusionar la pull request si tiene acceso para fusionar (merge access), o solicitar merge (fusión) de un responsable de mantenimiento.
- El bot @all-contributors debería ser llamado para agregar cualquier nuevo colaborador a la lista de colaboradores en el archivo README.md. Cada tipo de contribución puede ser indicado en lugar de
[contribution
type]
a continuación, se puede encontrar la lista completa de tipos de contribuciones disponibles en el enlace anterior.
@all-contributors
please
add
@[GitHub
handle]
for
[contribution
type]
Nuevas funcionalidades/Mejora de Funcionalidades
El proceso para una pull request de new feature (nuevas funcionalidades),o feature_enhacement (mejora de funcionalidades) es similar a las correcciones de errores,pero solo con una diferencia notable:
- Una pull request de nueva funcionalidad o mejora de funcionalidad debe ser revisada y aprobada por al menos dos supervisores o responsables de mantenimiento antes de que pueda ser fusionada.
Dependabot
Las pull requests de Dependabot generalmente solo son visibles para los administradores del repositorio, así que si esto no aplica a ti, por favor omite esta sección.
- Las pull request de Dependabot pueden fusionarse directamente si la actualización de la versión es una semver versión de parche y la prueba automatizada de CI ha pasado.
- Las pull requests de Dependabot con cambios de versión semver menor generalmente se pueden fusionar directamente siempre y cuando la prueba automatizada de CI pase. Se recomienda hacer una rápida verificación en el registro de cambios de la dependencia actualizada.
- Las pull requests de Dependabot con cambios de versión principal de semver pueden afectar probablemente el proceso de compilación o las funcionalidades de p5.js. Se anima al revisor, en este caso, a revisar el registro de cambios desde la versión actual hasta la versión objetivo si es posible y probar la pull request localmente para asegurarse de que todos los procesos estén funcionando y realizar cualquier cambio necesario debido a posibles cambios disruptivos en las dependencias.
- Muchas dependencias aumentan los números de versión principales solo porque dejan de admitir oficialmente versiones muy antiguas de Node.js. En muchos casos, los cambios de versión principal no necesariamente implican cambios disruptivos resultantes de cambios en la API de dependencias.
Proceso de Construcción
Esta sección no cubrirá la configuración general de construcción ni los comandos, sino más bien detalles sobre lo que sucede detrás de escena. Consulta las directrices para administradores para obtener información más detallada sobre la construcción.
El archivo Gruntfile.js contiene las definiciones principales de construcción para p5.js. Entre las diferentes herramientas utilizadas para construir la biblioteca y la documentación se incluyen, pero no se limitan a: Grunt, Browserify, YUIDoc, ESLint, Babel, Uglify y Mocha. Puede ser útil comenzar con la tarea default
y retroceder desde allí. También puede ser útil abrir el documento Gruntfile.js mientras se sigue la explicación a continuación.
Tarea Principal de Construcción
grunt.registerTask('default', ['lint', 'test']);
Cuando ejecutamos grunt
o el script npm npm test
, ejecutamos la tarea predeterminada que consiste en lint
y luego test
.
Tarea lint
grunt.registerTask('lint', ['lint:source', 'lint:samples']);
La tarea lint
consiste en dos sub tareas: lint:source
y lint:samples
. lint:source
está subdividida aún más en tres sub tareas adicionales: eslint:build
, eslint:source
y eslint:test
, que utilizan ESLint para verificar los scripts de construcción, el código fuente y los scripts de prueba.
La tarea lint:samples
primero ejecutará la tarea yui
, que a su vez consiste en yuidoc:prod
, clean:reference
y minjson
, que extraen la documentación del código fuente en un documento JSON, eliminan archivos no utilizados del paso anterior y minifican el archivo JSON generado en `data.min.json, respectivamente.
A continuación en lint:samples
está eslint-samples:source
, que es una tarea escrita personalizada cuya definición está en ./tasks/build/eslint-samples.js; ejecutará ESLint para verificar el código de ejemplo de la documentación y asegurarse de que siga la misma convención de codificación que el resto de p5.js (yui
se ejecuta primero aquí porque necesitamos que el archivo JSON se construya primero antes de que podamos aplicar lint a los ejemplos).
Tarea test
grunt.registerTask('test', [
'build',
'connect:server',
'mochaChrome',
'mochaTest',
'nyc:report'
]);
Primero, veamos la tarea build
dentro de test
.
grunt.registerTask('build', [
'browserify',
'browserify:min',
'uglify',
'browserify:test'
]);
Las tareas que comienzan con browserify
están definidas en ./tasks/build/browserify.js. Todas siguen pasos similares con diferencias menores. Estos son los pasos principales para construir la biblioteca completa de p5.js a partir de sus numerosos archivos fuente en uno solo:
browserify
construye p5.js, mientras quebrowserify:min
construye un archivo intermedio para ser minificado en el siguiente paso. La diferencia entrebrowserify
ybrowserify:min
es quebrowserify:min
no contiene datos necesarios para que funcione FES.uglify
toma el archivo de salida debrowserify:min
y lo minifica en el p5.min.js final (la configuración de este paso está en el archivo Gruntfile.js principal).browserify:test
está construyendo una versión idéntica y completa a la de p5.js, salvo por el código adicional que se utiliza para informar sobre la cobertura de código de prueba (usando Istanbul).
Primero, el uso del código específico de node.js fs.readFileSync()
es reemplazado por el contenido real del archivo utilizando brfs-babel
. Esto se utiliza principalmente en el código WebGL para insertar código de shader desde archivos fuente escritos como archivos separados.
A continuación, el código fuente, incluidas todas las dependencias de node_modules, se transpila usando Babel para cumplir con el requisito de Browserslist definido en package.json, así como para convertir las declaraciones de importación ES6 en require()
de CommonJS que browserify comprende. Esto también nos permite utilizar una sintaxis más nueva disponible en ES6 y más allá sin la preocupación por la compatibilidad del navegador.
Después de empaquetar pero antes de que el código empaquetado se escriba en el archivo, el código se pasa por pretty-fast
. Si no está destinado a ser minificado, debería ser limpiado para que el formato final sea un poco más consistente (anticipamos que el código fuente de p5.js se pueda leer e inspeccionar si se desea).
Aquí se omiten algunos pasos detallados pequeños; puedes revisar el archivo de definición de construcción de browserify vinculado arriba para ver todo más de cerca.
connect:server
Este paso inicia un servidor local que aloja los archivos de prueba y los archivos de código fuente construidos para que las pruebas automatizadas puedan ejecutarse en Chrome.
mochaChrome
Este paso está definido en ./tasks/test/mocha-chrome.js. Utiliza Puppeteer para iniciar una versión sin interfaz de usuario de Chrome que puede ser controlada de forma remota y ejecuta las pruebas asociadas con los archivos HTML en la carpeta ./test
, que incluye la prueba de la versión sin minificar y minificada de la biblioteca contra los conjuntos de pruebas unitarias, así como la prueba de todos los ejemplos de referencia.
mochaTest
Este paso difiere de mochaChrome
en que se ejecuta en node.js en lugar de en Chrome y solo prueba un pequeño subconjunto de características en la biblioteca. La mayoría de las características en p5.js requerirán un entorno de navegador, por lo que este conjunto de pruebas solo debe ampliarse si las nuevas pruebas realmente no necesitan un entorno de navegador.
nyc:report
Finalmente, después de que todas las construcciones y pruebas estén completas, este paso recopilará el informe de cobertura de pruebas mientras mochaChrome
estaba probando la versión completa de la biblioteca y mostrará los datos de cobertura de pruebas en la consola. La cobertura de pruebas para p5.js es principalmente para monitorear y tener algunos puntos de datos adicionales; tener una cobertura de pruebas del 100% no es un objetivo.
¡Y eso cubre la tarea predeterminada en la configuración de Gruntfile.js!
Tarea Variada
Todos los pasos pueden ejecutarse directamente con npx grunt [step]
. También hay algunas tareas que no se mencionan arriba pero podrían ser útiles en ciertos casos.
grunt yui:dev
Esta tarea ejecutará las construcciones de documentación y biblioteca descritas arriba, seguidas de la puesta en marcha de un servidor web que sirve una versión funcionalmente similar de la página de referencia que encontrarás en el sitio web en http://localhost:9001/docs/reference/. Luego, supervisará el código fuente en busca de cambios y reconstruirá la documentación y la biblioteca.
grunt
yui:dev
es útil cuando estás trabajando en la referencia en la documentación en línea porque no necesitas mover archivos construidos del repositorio de p5.js a un repositorio local de un sitio de p5.js y reconstruir el sitio web cada vez que hagas un cambio, y puedes previsualizar tus cambios con esta versión ligeramente simplificada de la referencia en tu navegador. De esta manera, también puedes tener más confianza en que los cambios que hiciste probablemente se mostrarán correctamente en el sitio web. Ten en cuenta que esto solo está destinado a modificaciones en la documentación en línea; los cambios en la página de referencia en sí, incluido el estilo y el diseño, deben hacerse y probarse en el repositorio del sitio web.
grunt watch
grunt watch:main
grunt watch:quick
Las tareas de observación vigilarán una serie de archivos en busca de cambios y ejecutarán tareas asociadas para construir la referencia o la biblioteca según los archivos que hayan cambiado. Estas tareas hacen lo mismo, la única diferencia es el alcance.
La tarea watch
ejecutará todas las construcciones y pruebas de manera similar a ejecutar la tarea predeterminada completa al detectar cambios en el código fuente.
La tarea watch:main
ejecutará la construcción y las pruebas de la biblioteca, pero no reconstruirá la referencia al detectar cambios en el código fuente.
La tarea watch:quick
ejecutará solo la construcción de la biblioteca al detectar cambios en el código fuente.
Dependiendo de en qué estés trabajando, elegir la tarea de observación más mínima aquí puede ahorrarte tener que ejecutar manualmente una reconstrucción cada vez que desees hacer algunos cambios.
Proceso de Lanzamiento
Consulta release_process.md.
Consejos y Trucos
A veces, la cantidad de issues y PR que requieren revisión puede ser un poco abrumadora. Si bien intentamos implementar procesos que faciliten las cosas, hay algunos consejos y trucos que puedes utilizar para ayudar con la revisión de issues y PRs.
Plantillas de Respuesta
Una característica útil de GitHub que puedes utilizar es la funcionalidad Respuestas Guardadas, que está disponible para usar al redactar una respuesta a issues o pull requests. Algunos de los flujos de trabajo descritos anteriormente pueden requerir responder a issues o PRs con respuestas idénticas o muy similares (redireccionar preguntas al foro, aceptar un problema para su corrección, etc.), y usar Respuestas Guardadas puede hacer que esto sea un poco más eficiente.
A continuación, se muestran algunas de las Respuestas Guardadas que están siendo utilizadas por los mantenedores de p5.js. ¡Puedes usarlas tú mismo o crear las tuyas!
Cerrando: No se puede Reproducir
No podemos reproducir esto, pero no dudes en reabrir si puedes proporcionar un ejemplo de código que demuestre el problema. ¡Gracias!
Cerrando: Necesita Fragmento
Estoy cerrando esto por motivos organizativos. Por favor, reabre si puedes proporcionar un fragmento de código que ilustre el issue. ¡Gracias!
Cerrando: Usa el Foro
Los issues de GitHub aquí son un buen lugar para los issues y problemas con la biblioteca p5.js en sí. Para preguntas sobre cómo escribir tu propio código, pruebas o seguir tutoriales, el foro es el mejor lugar para publicar. ¡Gracias!
Cerrando: GSOC
¡Gracias! El mejor lugar para discutir las propuestas de GSOC es en nuestro foro.
Cerrando: Acceso
No veo mucho interés en esta función, y no tenemos una explicación clara de cómo amplía el acceso, así que cerraré esto por ahora. Si se puede agregar una declaración de acceso a la solicitud del issue, no dudes en volver a abrirlo.
No vemos una explicación más detallada de cómo esta cuestión amplía el acceso, así que cerraré este issue por ahora. Si se puede agregar una declaración de acceso más detallada a la solicitud de función, no dudes en volver a abrirla. ¡Gracias!
Cerrando: Complemento
Creo que esta función está fuera del alcance de la API de p5.js (intentamos mantenerla lo más minimalista posible), pero podría ser un gran punto de partida para una biblioteca complementaria. Consulta la documentación aquí sobre cómo crear un complemento: https://github.com/processing/p5.js/blob/main/contributor_docs/creating_libraries.md
Cerrando PR: Primero Necesita Issue
Gracias. Como recordatorio, primero deben abrirse issues antes de que se abran pull request y etiquetarse con el issue. Esto es necesario para realizar un seguimiento del desarrollo y mantener la discusión clara. ¡Gracias!
Aprobar issue para corrección
Puedes seguir adelante con una solución. Gracias.
PR Fusionado
Se ve bien. ¡Gracias!
GitHub CLI
Revisar un PR complejo puede ser difícil con comandos de git complejos necesarios para obtener la versión del código del PR localmente para que puedas probarla. Afortunadamente, GitHub CLI puede ayudar enormemente con este proceso y más.
Después de instalar GitHub CLI e iniciar sesión, revisar una PR localmente se puede hacer ejecutando el comando gh pr checkout [id_del_pull_request]
, y el proceso de obtener un fork remoto, crear una rama y cambiar a la rama se realizan automáticamente para ti. Volver a la rama principal será lo mismo que cambiar de rama ejecutando git checkout main
. ¡Incluso puedes dejar un comentario en el PR desde la CLI sin necesidad de visitar la página web en absoluto!
También hay muchos otros comandos disponibles en GitHub CLI que puedes encontrar útiles o no, pero es una buena herramienta para tener en cualquier caso.
Gestión de Notificaciones
En lugar de monitorear manualmente las pestañas Issues o Pull Requests del repositorio en busca de nuevos issues o PRs, puedes “ver” el repositorio haciendo clic en el botón Watch con un ícono de ojo en la parte superior de la página del repositorio, frente al nombre del repositorio.
Al observar un repositorio, eventos como nuevos issues, nuevos pull requests, menciones de tu nombre de usuario y otras actividades a las que te hayas suscrito en el repositorio se enviarán como notificaciones a tu página de notificaciones, donde se pueden marcar como leídas o descartadas de la misma manera que un buzón de correo electrónico.
En algunos casos, también puedes recibir correos electrónicos de GitHub sobre eventos en el repositorio que estás observando, y puedes personalizarlos (incluida la desuscripción completa de ellos) desde tu página de configuración de notificaciones.
Configurar estas opciones para que se adapten a la forma en que trabajas puede ser la diferencia entre tener que buscar issues/PRs relevantes para revisar manualmente y sentirse abrumado por notificaciones interminables de GitHub. Se requiere un buen equilibrio aquí. Como sugerencia inicial, los supervisores deberían observar este repositorio para Issues y Pull Requests y configurarlo para recibir correos electrónicos solo sobre “Participando, @menciones y personalizadas”.