2010-05-10 23 views
5

Luché para hacer esa pregunta, pero aquí está. Uso el control de fuente desde hace varios años para múltiples proyectos usando diferentes sistemas (svn, hg, git) y aprendí cómo mejorar mis mensajes siguiendo las pautas, etc. Pero, por lo que puedo recordar, nunca he echado un vistazo a ellos después¿Cuál es el uso de los mensajes de confirmación?

Entonces ... ¿cómo aprovechas tus propios mensajes de compromiso? Cuando necesito volver porque rompí algo y necesito un nuevo comienzo, por lo general vuelvo al último "nodo" (donde comencé o fusioné una sucursal). ¿Escribo esos mensajes solo para personas que monitorean el proyecto que sienten curiosidad por saber qué está pasando?

Saludos

Respuesta

6

"Envíame una lista de las cosas que hizo en las últimas dos semanas" - Boss

+0

Tendré que hablar con mi jefe sobre la confianza y la forma en que trabajan los programadores. O irse;) – ericteubert

+3

Esto puede no tener nada que ver con la confianza. Específicamente en un caso que viene a la mente, solo quería saber qué poner en el documento de notas de la versión. – shoosh

+0

buen punto shoosh – ericteubert

3

Una cosa que he encontrado es que los mensajes de cometer son una buena manera de mantener a mí mismo de no cometiendo con suficiente frecuencia. Si no puedo poner los cambios en un breve mensaje de compromiso, probablemente debería haber cometido los cambios antes.

4

Sus mensajes son más para otros usuarios que usted. Aunque me aseguro de colocar buenos mensajes de confirmación incluso en repositorios personales. Lo ayuda cuando se desvía de un proyecto y lo visita meses después para hacerse una idea del trabajo reciente realizado en un proyecto.

+2

No hay nada que odie más que actualizar y obtener docenas de archivos actualizados y no tener un mensaje que me diga por qué esos archivos tuvieron que ser cambiados. – tster

+0

De acuerdo. Veo que el código se compromete con una biblioteca común sin ninguna pista de por qué fueron creadas, eso me encanta;) –

7

Los escribe como una ayuda para su yo futuro, y para otros en el equipo. Para darle algunos antecedentes sobre cuándo los he encontrado útiles:

Solía ​​trabajar en un proyecto donde los mensajes de confirmación eran invaluables, en más de una ocasión los usé para rastrear el código que tenía años. En ese proyecto, nuestro sistema de seguimiento de errores también se integró con nuestro VCS (ClearCase). Entonces, cuando registraste un cambio, registraría el número de error en los comentarios de confirmación. Esto fue muy útil para permitirle rastrear exactamente qué fue cambiado y por qué.

Para resumir, aunque los mensajes de compromiso pueden parecer inútiles si recién está empezando (especialmente si usted es el único que trabaja en el proyecto), adquieren un valor inestimable una vez que tiene un producto exitoso compatible con producción por múltiples desarrolladores.

actualización

Otra característica útil de los mensajes de confirmación es que requieren a revisar y resumir los cambios que acaba de realizar. Incluso si recuerdo lo que he cambiado, a menudo haré una rápida modificación de un archivo antes de registrarlo. Lo leeré brevemente de nuevo para asegurarme de que no haya errores tipográficos, que cambié todo lo que quería decir, etc. Esta es una manera simple de revisar su código para esos pequeños pequeños errores que de otra manera encontrarían su camino en su código. De todos modos, después de hacer esto, tengo una idea clara de lo que ha cambiado, así que uso esto para escribir un resumen conciso del cambio al registrar el archivo. Este es un hábito simple que ayuda a aumentar la calidad del código con poco esfuerzo de su parte.

1

En el mejor de los casos, una confirmación está vinculada a un elemento de trabajo en un rastreador de funciones/errores. De esta forma, podrá ver fácilmente qué característica/error ha sido implementado/arreglado. Esto no solo es útil para saber si una determinada revisión contiene una función o solución de error, sino también para crear fácilmente una nota de lanzamiento.

1

¿Cuál sería el punto de una confirmación sin una nota para decirle qué es? Es como preguntar '¿Por qué los libros tienen títulos en los lados?', O quizás '¿Por qué los libros tienen índices y números de página?'. Me parece que un registro de control de fuente que no tenía una descripción para cada cambio no sería muy útil.

razones es posible que tenga que consultar el mensaje de confirmación incluye

  • Un error ha surgido y que desea encontrar cuando esa parte del código se cambió última
  • usted decide deshacer algunos cambios y necesidad para decidir qué revisión revertir a

Para cualquiera de estas posibilidades, sin buenos mensajes de confirmación, se quedaría mirando a través de los diffs para cada confirmación individual hasta que encuentre lo que estaba buscando en el código.

Cuestiones relacionadas