• Saltar al contenido principal
  • Skip to secondary menu
  • Saltar a la barra lateral principal
  • Saltar al pie de página
  • Inicio
  • Secciones
    • Ciencia de datos
    • Criptografía
    • Herramientas
    • Machine Learning
    • Noticias
    • Opinión
    • Productividad
    • Programación
      • JavaScript
      • Julia
      • Matlab
      • Python
      • R
  • Programación
    • JavaScript
    • Julia
    • Matlab
    • Python
    • R
  • Noticias
  • Boletín
  • Contacto
  • Tienda
    • Libros
    • Equipamiento de oficina
    • Equipamiento en movilidad
    • Tiendas afiliadas
      • AliExpress
      • Amazon
      • Banggood
      • GeekBuying
      • Lenovo

Analytics Lane

Ciencia e ingeniería de datos aplicada

  • Ciencia de datos
  • Machine Learning
  • Python
  • Pandas
  • NumPy
  • Matlab
  • Julia
  • JavaScript
  • Excel

Estandarización de los mensajes en Git

marzo 18, 2022 Por Daniel Rodríguez Deja un comentario
Tiempo de lectura: 3 minutos

A la hora de escribir código siempre es necesario prestar atención a los comentarios. Especialmente a que estos sean los necesarios, un exceso puede ser más una fuente de ruido que otra cosa, para que una persona pueda comprender lo que se presencia hacer. En especial, nosotros mismos en el futuro. Algo que también sucede en los sistemas de gestión de versiones. Los mensajes que se incluyen en cada subida deben hacer el mismo papel que los comentarios en el código: explicar qué cambios se incluyen y el motivo por el que incluyeron. Así, en futuras revisiones, cuando se busque un cambio en concreto será más fácil localizarlos. Para lo que se puede recurrir a la estandarización de los mensajes en Git. A continuación, propongo un método para crear estos de modo que sea fácil incluir la información necesaria.

¿Por qué estandarizar los mensajes de Git?

La estandarización de los procedimientos es algo que suele aportar grandes ventajas. Seguir un procedimiento a la hora de realizar una tarea evita el olvido de alguna parte, homogeneiza la calidad del producto final y al mismo tiempo que nos hace más productivos. Por eso, la estandarización de los mensajes en Git ofrece ventajas como:

  • Hace que el historial de subidas sea más legible, facilitando de este modo la revisión del código.
  • Facilita la redacción de los mensajes, ya no es necesario pensar qué escribir porque estará definido por el procedimiento.
  • Evita olvidos, ya que todo lo que se necesita incluir estará en el estándar.

Información necesaria en un mensaje de Git

Antes de crear un estándar para los mensajes de Git es necesario pensar en qué información se debe incluir en estos. Lo que básicamente es:

  • tipo: identificar si la subida es una nueva característica, la solución de un fallo, una refactorización de código, …
  • detalle: señalar cuál es el cambio que se ha incluido, algo que se puede redactar con una frase.
  • motivo: enlazar con el gestor de tickets para saber el mítico por el que ha introducido el cambio.

Propuesta básica para estandarizar los mensajes de Git

Con lo visto hasta ahora se puede pensar en una propuesta básica para estandarizar los mensajes de Git. Algo como lo siguiente:

Publicidad


tipo: detalle (motivo)

Así un mensaje podrá ser algo como:

característica: inclusión de la distribución Gumbel (164)

Con lo que se puede obtener de un vistazo la mayoría de la información necesaria. La subida es una característica, en concreto la inclusión de la distribución Gumbel, y el ticket asociado es el 164.

Incluir más información en el estándar

En algunos casos puede que el estándar propuesto anteriormente sea algo escaso. En grandes proyectos existen diferentes partes y puede que sea aconsejable saber cuales se ven afectadas. Además, puede que un mensaje corto no sea suficiente para explicar los cambios. En este caso es mejor dejar un título corto en la primera línea y escribir los detalles en una segunda (si, en Git es posible escribir mensajes de más de una línea). Una segunda línea que no debería exceder el tamaño de un tweet.

La parte del programa que se ve afectada se puede agregar al tipo de subida y escribir más líneas en el mensaje. Por lo que el estándar ampliado puede quedar algo como lo siguiente

tipo - alcance: detalle (motivo)

descripción

En el caso del ejemplo anterior quedaría algo como lo siguiente:

Publicidad


característica - distribuciones: inclusión de la distribución Gumbel (164)

En el módulo de distribuciones se incluye la distribución Gumbel

Conclusiones

En esta ocasión se ha propuesto un estándar para mejorar los mensajes de Git de cara a conseguir una estandarización de los mismos. Algo con lo que se puede servir para mejorar el trabajo de los equipos.

Imagen de Antonios Ntoumas en Pixabay

¿Te ha parecido de utilidad el contenido?

¡Puntúalo entre una y cinco estrellas!

Puntuación promedio 0 / 5. Votos emitidos: 0

Ya que has encontrado útil este contenido...

¡Síguenos en redes sociales!

¡Siento que este contenido no te haya sido útil!

¡Déjame mejorar este contenido!

Dime, ¿cómo puedo mejorar este contenido?

Publicaciones relacionadas

  • lottery
    Ganar con números calientes y fríos en la Primitiva
  • Loteria de Navidad
    Lotería de Navidad para no estadísticos
  • source-code-583537_1920
    Introducción a los sistemas de control de versiones con Git
  • bingo
    Números calientes en Bonoloto: mismos resultados que el azar
  • games
    ¿Es aconsejable jugar a la lotería?
  • RIGHT_AND_WRONG
    Cómo trabajar de forma confortable en la oficina o casa

Publicado en: Herramientas, Opinión Etiquetado como: Git

Interacciones con los lectores

Deja una respuesta Cancelar la respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

I accept the Terms and Conditions and the Privacy Policy

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.

Publicidad





Barra lateral principal

Suscríbete a nuestro boletín

Suscríbete al boletín semanal para estar al día de todas las publicaciones.

Política de Privacidad

Analytics Lane en redes sociales

  • Amazon
  • Facebook
  • GitHub
  • Instagram
  • Pinterest
  • RSS
  • Twitter
  • Tumblr
  • YouTube

Publicidad

Entradas recientes

Mantener un sistema de alta disponibilidad con PostgreSQL y repmgr

diciembre 1, 2023 Por Daniel Rodríguez

Diferencias entre los errores 401 y 403 del estándar HTTP

noviembre 29, 2023 Por Daniel Rodríguez

Ver el código de cualquier función en Python

noviembre 27, 2023 Por Daniel Rodríguez

Publicidad

Es tendencia

  • Diferentes formas de ordenar dataframes en pandas publicado el abril 29, 2019 | en Python
  • Operaciones de filtrado de DataFrame con Pandas en base a los valores de las columnas publicado el mayo 10, 2019 | en Python
  • Seleccionar filas y columnas en Pandas con iloc y loc publicado el junio 21, 2019 | en Python
  • Cómo encontrar la posición de elementos en una lista de Python publicado el abril 12, 2021 | en Python
  • pandas Pandas: Cómo crear un DataFrame vacío y agregar datos publicado el noviembre 16, 2020 | en Python

Publicidad

Lo mejor valorado

4.9 (22)

Seleccionar filas y columnas en Pandas con iloc y loc

4.7 (12)

Operaciones de filtrado de DataFrame con Pandas en base a los valores de las columnas

4.6 (15)

Archivos JSON con Python: lectura y escritura

4.5 (10)

Diferencias entre var y let en JavaScript

4.4 (13)

Ordenación de diccionarios en Python mediante clave o valor

Publicidad

Comentarios recientes

  • Anto en Rendimiento al iterar en JavaScript sobre un vector
  • Daniel Rodríguez en Creación de un certificado Let’s Encrypt en Windows con Win-Acme
  • Guillermo en Creación de un certificado Let’s Encrypt en Windows con Win-Acme
  • Daniel Rodríguez en ¿Cómo eliminar columnas y filas en un dataframe pandas?
  • Miguel en ¿Cómo eliminar columnas y filas en un dataframe pandas?

Publicidad

Footer

Analytics Lane

  • Acerca de Analytics Lane
  • Boletín de noticias
  • Contacto
  • Libros
  • Lo más popular
  • Noticias
  • Tienda
  • Tiendas afiliadas

Secciones

  • Ciencia de datos
  • Criptografía
  • Herramientas
  • Machine Learning
  • Opinión
  • Productividad
  • Programación
  • Reseñas

Sobre de Analytics Lane

En Analytics Lane tratamos de explicar los principales conceptos de la ciencia e ingeniería de datos con un enfoque práctico. Los principales temas tratados son ciencia de datos, ingeniería de datos, inteligencia artificial, machine learning, deep learning y criptografía. Además, también se habla de los principales lenguajes de programación y herramientas utilizadas por los científicos e ingenieros de datos.

Copyright © 2018-2023 Analytics Lane ·Términos y condiciones ·Política de Cookies ·Política de Privacidad ·Herramientas de privacidad ·Contacto