Solicitudes de incorporación de cambios

Esta página describe las herramientas utilizadas para la contribución y revisión del código.

Las revisiones son una medida clave para garantizar que los cambios sean de buena calidad. Ayudan a prevenir errores, incoherencias de diseño o posibles problemas de mantenimiento. Además, saber que el trabajo será revisado también suele ayudar a conservar un mayor grado de atención durante el proceso.

Nota

Los escritores a los que se les ha dado acceso de confirmación pueden enviar al repositorio principal sin necesidad de ramificar el repositorio principal.

Ver Pautas de Confirmación si esto fuera aplicable.

Configuración por única vez

Esto supondrá que ya se cuenta con el repositorio del manual de Blender descargado en el equipo, siguiendo las instrucciones de instalación.

Ramificación

  1. Ir al repositorio de Blender y hacer clic en el botón Fork.

  2. Confirmar la ramificación usando las opciones predefinidas.

  3. Ahora se deberá agregar la ramificación personal como remota en el repositorio local de git. Hacer clic en SSH para ver la URL correcta y luego agregarla así:

    git remote add me [email protected]:<USERNAME>/blender-manual.git

Nota

Con el fin de enviar hacia el repositorio de la bifurcación, se necesitará una clave SSH. Si aún no se tiene el archivo ~/.ssh/id_rsa.pub, existe un comando simple para generar dichas claves, que funciona en Linux, macOS y en Git Bash en Windows:

ssh-keygen

Este comando generará una clave privada id_rsa y una clave pública id_rsa.pub en ~/.ssh. La clave privada nunca deberá mostrarse ni enviarse a nadie más, para evitar comprometer la cuenta, pero la clave pública será segura para compartir.

El contenido de ~/.ssh/id_rsa.pub se podrá copiar y pegar en configuración de la cuenta en projects.blender.org , después de hacer clic en «Add Key». Cualquier nombre para la clave SSH estará bien.

Flujo de trabajo

The workflow for working with pull requests can be found in the Blender Developer’s Documentation.

Tener en cuenta que parte del texto de la guía anterior se centra en el repositorio principal de Blender; sin embargo, el flujo de trabajo será el mismo para cualquier proyecto de Blender.

Directrices para supervisores

  • El texto de la solicitud de incorporación de cambios deberá poder usarse como el mensaje de confirmación de git (consultar las pautas para obtener más detalles).

  • Ser explícito cuando se deba resolver algunos cambios antes de confirmarlos, sin necesidad de una nueva ronda de revisión.

  • Si la solicitud de incorporación de cambios no fuera aprobada, se esperará que el autor realice otro intento.

  • Si el cambio necesitara un acuerdo sobre la tarea de diseño primero, poner la solicitud de incorporación de cambios en espera agregando un prefijo WIP: en el título, lo que indicará que el autor considera que la solicitud de extracción no está lista para fusionarse. No se esperará a una revisión a menos que el autor lo solicite específicamente.

  • Se espera que los escritores respondan a las solicitudes de incorporación en 3 días hábiles.

  • Agregar los módulos o proyectos relevantes a las etiquetas.

  • Animar a los nuevos escritores a revisar, es una buena manera de aprender e importante para hacer crecer el proyecto.

Consejos

  • Para obtener el archivo del parche, agregar .patch al final de la URL de la solicitud de incorporación de cambios. Ejemplo:

    https://projects.blender.org/blender/blender-manual/pulls/104892.patch

  • Descargar una solicitud de incorporación con un encabezado separado (sin dejar detrás una rama). Ejemplo:

    git fetch -q origin +refs/pull/104892/head: ; git checkout -qf FETCH_HEAD