Patch & Commit

Submit Patches

The first few times you make changes to the manual, you will need to submit them as patches for an administrator to review. This is just to make sure that we maintain a quality user manual, and that you do not accidentally break anything vital before you get used to the system.

In order to submit a patch, follow this process:

  1. Make any changes that you want.

  2. Create a patch file by running:

    svn diff > filename.diff

    This creates a simple text file that shows what text was added, removed or changed between your working files and the central repository.

    If you have created or deleted files, you will need to run svn add /path/to/file or svn rm /path/to/file before creating the diff. To see a list of affected files, run svn status.

  3. Upload the diff file here. If you do not have an account already, you can register for one.

  4. After submitting the diff, you will be asked to «Create a new Revision» before you can add a title and description of your changes.

  5. Please check if the Documentation project is assigned in the tag’s field in order to notify the team of your patch. You can also contact the team over the mailing list or Blender Chat.

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

Nota

If your patch includes changes to or additional images, simply attach them when you are creating the revision.

Straightforward patches are bound to be accepted very quickly. Once you get accustomed to making changes and no longer need feedback, we cut out the middle man and give you direct access to edit the manual.

Ver también

See Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

Commit Directly

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.

All you need to do now is run:

svn commit -m "This is what I did"

Cuando se omita -m "mensaje", se solicitará escribir el mensaje en un editor de texto.

Do not forget to always run svn update before committing.

Then you will be asked for your username and password (from developer.blender.org) before the change is committed.

Nota

Make sure to use your username (case sensitive) and not your email.

Your modified files are uploaded to the central repository for others to work with and continue collaborating. Commits are tracked in the repositories Diffusion. Soon after your changes become visible in the online manual.

Escribir un Buen Mensaje de Confirmación

Al realizar cambios en el manual que se relacionan directamente con una confirmación (cambio) específica en Blender, es útil hacer que el título de la confirmación sea el mismo que el de la confirmación realizada en Blender. Se solicita que incluya el hash de confirmación de la confirmación realizada en el código fuente de Blender.

Por ejemplo, el commit rBM8473 incluye un indicativo descriptivo de los cambios realizados junto con el hash rBa71d2b260170. El hash se puede extraer de la URL proporcionada en la tarea de documentación para una próxima versión específica.

Otros cambios más generales no tienen que seguir la política anterior; sin embargo, es importante que la descripción sea clara sobre qué cambios realizó y por qué. Puede ser útil agregar un prefijo al título de la confirmación con una palabra de prefijo como Cleanup: o Fix: cuando realiza limpiezas generales o correcciones, respectivamente.

Escribir buenos mensajes de confirmación ayuda a los administradores a realizar un seguimiento de los cambios realizados y garantiza que todas las funciones nuevas estén debidamente documentadas.