Mensajes de consignación

La siguiente es una lista de recomendaciones para escribir mensajes de consignación útiles.

• Indica el número de tarea al inicio del mensaje (e.g. #999).
• El mensaje de consignación debe describir qué cambio se hizo y por qué.
• El mensaje debe comenzar con un verbo en modo imperativo para describir qué cambio se hizo.
• Describir por qué se hizo el cambio es más importante que describir qué cambio se hizo.
• Cada línea debe ser menor o igual a 80 caracteres.
• La primer línea debe ser una oración completa.
• El resto del mensaje se debe ser un texto formado por párrafos.
• El mensaje puede ser tan extenso como sea necesario para describir la consignación de forma detallada.
• Es más fácil redactar los mensajes cuando se hacen muchas consignaciones con pocos cambios en lugar de pocas consignaciones con muchos cambios.

Sistemas de Control de Versiones

Git es el único sistema de control de versiones que usamos. Usamos dos hospederos web de nuestros repositorios:

• Bitbucket: para repositorios clase 3
• GitHub: para repositorios clase 1

GitFlow

Usamos GitFlow como lo muestra el diagrama de abajo.

Para pasar (merge) los cambios de una feature a la rama develop, o de un release a la ramas master y develop, los cambios deben ser aprobados en revisión por pares mediante un pull request. Es preferible que el merge lo haga el revisor quien aprobó el pull request pero también lo puede hacer el autor.

Consideramos feature los cambios que introducen nuevos productos (resultados, contenido, etc.) y que generalmente incrementan la deuda técnica. Consideramos release los cambios que refactorizan código existente (5 archivos, reporte, post-entrega, documentación, pruebas, etc.) y que disminuyen la deuda técnica.

Contenido

• Sólo se consignaran archivos de texto simple (csv, json, svg, tex, txt, etc.), nunca binarios.
• No se consignarán archivos mayores a 1 MB (> 10 mil líneas de código).
• Se prefieren las imágenes svg sobre cualquier formato binario. Excepcionalmente se podrán consignar imágenes binarias si son para una aplicación que depende de las imágenes para funcionar siempre y cuando el lado más grande sea ≤ 256 pixeles
• Las excepciones a las reglas anteriores serán consensuadas.