Git y la guía de logging de cambios

Soy un novato con git y me gustaría saber cuál es la mejor práctica para crear tags y generar / mantener un logging de cambios.

Hasta ahora, siempre he creado un file readme.md e indico manualmente (en la sección "changelog") la característica más importante

Por ejemplo:

versión 1.0.1

  • cambio de layout en el hogar
  • diapositivas agregadas en la galería
  • etc.

¿Cómo puedo crear un logging de cambios (tal vez en formatting de networkingucción) con estas características?

  • título de los cambios basados ​​en el título / date personalizada de las tags / tags
  • cambios basados ​​en tags o confirmaciones

Todavía no tengo una idea clara, así que las sugerencias son agradables

Gracias por adelantado 🙂

Todavía no hay algunas pautas comunes. Pero se explican muchas buenas reglas para mantener un logging de cambios .

Y como mencionan:

No dejes que tus amigos vuelquen los loggings de git en los loggings de cambios.

Y estoy totalmente de acuerdo con eso.

Es por eso que creé GitHub Changelog Generator que genera un logging de cambios de acuerdo con todas estas pautas.

En realidad, solo funciona con GitHub , pero presenta un buen ejemplo de cómo debería ser un logging de cambios.

Genera automáticamente un logging de cambios de sus tags, problemas, tags y requestes de extracción.

Por ejemplo: este logging de cambios fue generado por este script: CHANGELOG.md

Registro de cambios

1.2.5 (2015-01-15)

Registro de cambios completo

Mejoras implementadas:

  • Usar hito para especificar en qué versión de error se corrigió # 22

Errores arreglados:

  • Error al intentar generar logging para repos sin tags # 32

Solicitudes de extracción combinadas:

  • La class PrettyPrint está incluida en minúsculas 'pp' # 43 ( schwing )

  • soporte empresarial github a través de opciones de línea de command # 42 ( glenlovett )

Le sugiero que todavía describa manualmente los cambios en el logging de cambios.

Difícil, puedes vincular a los cambios generados a través de github diff. Por ejemplo, el logging de cambios: https://github.com/rspec/rspec-core/blob/master/Changelog.md

Y el diff: https://github.com/rspec/rspec-core/compare/v2.14.2…master

Es posible que desee search en los repositorys de algunos otros proyectos de código abierto de reference donde se pueden encontrar muchas buenas prácticas.

Probablemente mi Asnwer es demasiado tarde, pero ahora estoy usando una increíble gem de Ruby, lee su logging de git y divide por tags, y el resultado está escrito en rebajas, eche un vistazo

https://github.com/kebab-project/katip