Alcance

Este documento cubre las especificaciones a cumplir cuando se realize un commit sobre los proyectos de gvSIG, así como qué debe ponerse en el ticket asociado a ese commit.

Los formatos indicados son específicos para Redmine, que es el sistema de gestión de incidencias y tareas usado actualmente en el proyeto gvSIG (https://devel.gvsig.org/redmine).

Descripción

Cuando un desarrollador realiza un commit sobre una parte de gvSIG que no se encuentra en desarrollo (no hay un proyecto en desarrollo sobre esa parte de gvSIG), deberá añadir, en el mensaje del commit, el número de ticket que describe la nueva funcionalidad o la corrección del bug de ese commit. Para ello utilizará el formato:

#ticket

Donde:

• ticket es el número de ticket dentro de Redmine.

es aconsejable añadir en el comentario del commit, ademas del enlace al ticket un pequeño comentario explicativo de lo que se ha hecho, en general podria valer el titulo del ticket asociado al commit.

Además de poner el mensaje en el commit, deberá incluir como comentario en el ticket, el número de revisión del SVN que arregla ese ticket. El formato del texto a añadir en el comentario sería (ojo con la letra r, es necesaria para indicar que es una revisión):

project:rREVISION-NUMBER

Donde:

• project, es el identificador del proyecto de Redmine en el que reside el SVN en el que se subió el cambio. En general, para gvSIG, será gvsig-desktop.
• REVISION-NUMBER es el número de revisión en el SVN en el que se arregla el ticket.

Ejemplo:

gvsig-desktop:r38195

En caso de que la resolución del ticket se materialice en varios commits, se añadirá, por cada commit, una línea al comentario con el formato descrito.

Existe un mecanismo que permite, directamente al hacer el commit de un cambio, referenciar o incluso marcar como resuelto un ticket de Redmine. Para ello basta incluir en el comentario del commit lo siguiente:

• Para referenciar un ticket:

  Refs #ticket
  

• Para marcar un ticket como fixed y poner su % Realizado al 100%:

  Fixes #ticket
  

Este mecanismo es recomendable ya que redmine lo reconoce y muestra de forma más integrada la información de los tickets con las revisiones relacionadas.