2010-03-01 9 views
6

Me gusta usar la notación de rebaja en mis mensajes de confirmación de subversión, planeando crear un día una función de "registro" que muestre los mensajes de confirmación en una página HTML, no a diferencia de la vista de "historial" de Trac. (Si Trac no tiene un complemento de marcación para entonces exactamente para ese fin)Usar el descuento en los mensajes de confirmación de subversión, ¿tiene alguna idea?

¿Alguien puede pensar en alguna razón contra esto?

Lo único especial que me viene a la mente es el uso de backticks, pero se deben evitar como cualquier otra cosa, así que no debería ser un problema.

Respuesta

3

¿Alguien puede pensar en alguna razón en contra de esto?

Sí: confirmaciones debe ser texto simple y sin adornos para alentar mensajes de compromiso mínimos. Si necesita ese tipo de formato, sus mensajes de compromiso no explican claramente el propósito del mensaje. En general, los mensajes de confirmación deben ser breves, descripciones breves de los cambios, no más de dos o tres oraciones. Si se necesitan más detalles o contexto, pueden hacer referencia a problemas externos (por ejemplo, "Soluciona el problema gráfico # 184").

Si esto no es solo una preferencia personal y sus confirmaciones realmente requieren una gran cantidad de detalles y formatos para explicar, entonces probablemente sean demasiado grandes y se dividan en trozos más pequeños y fáciles de digerir.

+2

A veces uso listas al corregir errores relacionados o al implementar funciones relacionadas en una única confirmación. – voyager

+0

De acuerdo. Mi control de fuente y bug db están integrados para que pueda referirme a casos en mis mensajes de confirmación, y se autoenlacen. Me gusta dar el caso # y una descripción rápida. Fácil de ver en una lista y desglosar si necesito más información. –

+1

@John buenos puntos, pero a veces me gustaría dar un breve resumen sobre los cambios (por ejemplo, 'xyz()' ahora necesita el 2 ° parámetro para ser 'int') también con el objetivo a largo plazo de crear registros de cambios. Sin embargo, un sistema de tickets puede ser la mejor opción para eso. De todos modos, me gusta hacer algunos formateos incluso con mensajes de registro precisos, por ejemplo 'function_names()' o ** bold **/* italic * para cosas importantes. –

3

Uso trac, que utiliza el marcado Wiki para todo (lo acabo de comprobar y también se usa en los registros de confirmación). Principalmente uso * o - para las listas, y las visualizo correctamente.

En la próxima confirmación veré si acepta los backticks (o {{{ y }}}, que también es aceptado por el marcado Wiki), pero lo más probable es que lo haga.

No veo una razón por la cual no deba usar Markdown en sus propios registros, y puede crear un pequeño complemento para su administración de proyectos y sistema de seguimiento de errores/problemas.

+2

Trac es realmente agradable porque los mensajes de confirmación como "arreglos # 42" se convierten en un enlace a un ticket, "soluciona el error introducido en [151]" se convierte en un enlace a otro conjunto de cambios. – chelmertz

Cuestiones relacionadas