19 octubre, 2015

Cómo escribir un buen mensaje de consignación

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

  • 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

Gracias a Yutzil y David por compilar la primer versión de esta lista.