La accesibilidad en la revisión de código: mensajes claros y commits atómicos

Fuentes: Please keep code descriptions simple

Una publicación reciente en el blog de AksDev reflexiona sobre un problema cotidiano en el desarrollo de software: la sobrecarga de información en las descripciones de código, mensajes de commit y solicitudes de fusión. La entrada, escrita desde una perspectiva personal basada en la accesibilidad cognitiva, sostiene que la mayor parte de esos textos se centran en explicar qué se ha cambiado, cuando lo realmente útil es comunicar por qué se ha hecho. El autor argumenta que el propio código ya describe el qué, y que un exceso de prosa solo entorpece la revisión, sobre todo para personas con déficit de atención.

El artículo propone varias prácticas concretas: redactar mensajes cortos y directos bajo el principio de «necesito saber»; evitar descripciones extensas que acumulen detalles superfluos; y mantener los commits atómicos, es decir, unidades de cambio que tengan sentido por sí solas. Para lograrlo, sugiere herramientas habituales de Git como git amend para pequeños ajustes, y rebase, limpieza o squash antes de fusionar una rama, de modo que el historial quede ordenado y sea fácil de revisar.

El texto también aborda el uso de herramientas de inteligencia artificial en la generación de comentarios y mensajes. Recomienda que los desarrolladores sigan escribiendo sus propias notas, ya que redactarlas les ayuda a entender el cambio y produce un contenido más accesible para quien revisa. El autor es crítico con la dependencia de estos asistentes y afirma que no son imprescindibles para escribir buen código. La pieza cierra reiterando que la clave está en la concisión, la claridad y la separación entre el qué y el por qué.