10/2/2012 13:39 El Bruno

[#ALM] Recomendaciones para los comentarios que agregamos en cada CheckIn

image47dd1de4

Buenas,

antes de empezar el post vamos a hacer un pequeño filtro:

¿Haces cómo mínimo un CheckIn diario?

si tu respuesta es diferente a “SI”, pues que sepas que por cada día que pasas sin proteger tu código en el repositorio de código fuente, matas a un unicornio y se desvanece un arco iris. La segunda pregunta también ayuda a seguir filtrando el asunto.

¿Alguno de tus comentarios es del siguiente tipo?

- He arreglado un error

- done!

- 1234567890

Es increíble pero muchas personas piensas que la caja de texto para los comentarios es solo decorativa y con un simple “.” alcanza.

Pues bien, para mejorar esto un poco les cuento un modelo de trabajo que viene bastante bien utilizar en los comentarios. Se trata de seguir el siguiente patrón:

+ add new elements, features, functions, etc.

- remove elements, features, functions, etc.

~ updated elements, features, functions, etc.

# defines a label or version

Con este esquema es más fácil encontrar comentarios del tipo

+ incorporada la funcionalidad para las trazas en base de datos

~ cambios en el formato de las trazas

o inclusive

~ cambios en el look and feel para ser OCD compliant

- imágenes viejas

 

De esta forma los comentarios son algo más que texto perdido en cada conjunto de cambios. Y finalmente un dato que es importante remarcar

Los comentarios deben comentar el POR QUÉ de un cambio no el CÓMO, para el CÓMO ya leeremos el código fuente.

 

Saludos @ La Finca

El Bruno

   

Archivado en: ,
Comparte este post: