Parches y Commit

Enviar Parches

Las primeras veces que realice cambios al manual, necesitarás enviarlos como parches para que los revise un administrador. Esto es solo para asegurarse de que mantenemos un manual de usuario de calidad y de que no rompas accidentalmente nada vital antes de acostumbrarte al sistema.

Para enviar un parche, sigue este proceso:

  1. Realiza los cambios que desees.

  2. Crea un archivo de parche al ejecutar

    svn diff > filename.diff

    Esto crea un archivo de texto simple que muestra qué texto fue agregado, removido o cambiado entre tus archivos de trabajo y el repositorio central.

    Si has creado o eliminado archivos, necesitarás ejecutar svn add /ruta/al/archivo o svn rm /ruta/al/archivo antes de crear el diff. Para ver una lista de los archivos afectados, ejecuta svn status.

  3. Sube el archivo diff aquí. Si aún no tienes una cuenta, puedes registrarte para una.

  4. Luego de enviar el diff, se te pedirá «Crear una nueva revisión» antes de que puedas agregar un título y una descripción de tus cambios.

  5. Por favor, verifica si el proyecto Documentación está asignado en el campo tag para notificar al equipo de tu parche. También puedes contactar al equipo en la lista de correo o El Chat de Blender.

  6. Ellos revisarán el parche e informarán a su autor sobre cualquier cambio que podría hacerse. Si no hay problema, el parche será aceptado y el equipo que lo verificó realizará un commit.

Nota

Si tu parche incluye cambios a imágenes (o imágenes adicionales), simplemente adjúntalas cuando estés creando la revisión.

Los parches directos están destinados a ser aceptados muy rápidamente. Una vez que te acostumbras a hacer cambios y ya no necesites de comentarios, quitamos al intermediario y te damos acceso directo para editar el manual.

Hacer “Commit” Directamente

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

Todo lo que necesitas hacer ahora es ejecutar:

svn commit -m "This is what I did"

Si no agregas -m "mensaje", se te pedirá que escribas un mensaje en un editor de texto.

No te olvides de ejecutar siempre svn update antes de hacer el “commit”.

Entonces se te pedirá tu nombre de usuario (de developer.blender.org) y la contraseña antes de que el cambio sea confirmado.

Tus archivos modificados son subidos al repositorio central para que otros trabajen con ellos y sigan colaborando. Los “commits” son rastreados en los repositorios Difusión . A continuación tus cambios se vuelven visibles en el manual en línea.

Writing a Good Commit Message

When making changes to the manual that directly relate to a specific commit (change) in Blender, it is helpful to make the title of the commit the same as the commit made to Blender. It is requested that you include the commit hash of the commit made to the Blender source code.

For example, the commit rBM8473 includes a descriptive indicative of the changes made along with the hash rBa71d2b260170. The hash can be extracted from the URL provided in the Documentation task for a specific upcoming release.

Other more general changes do not have to follow the above policy however, it is still important to make the description clear about what changes you made and why. It can be helpful to prefix the commit title with a prefix word such as Cleanup: or Fix: when you are making general cleanups or fixes respectively.

Writing good commit messages helps administrators keep track of changes made and ensures all new features are properly documented.