¿Está bien arreglar el formatting del código junto con la implementación de una function / reparación de un error?

Cuando se bifurca un proyecto y se trabaja en él, ¿está bien aportar soluciones de formatting de código junto con la implementación de una function / reparación de un error?

Ejemplos de esto incluyen:

  • Pestañas / espacios mixtos en un file que necesitas cambiar solo una línea
  • Distorsión diferente en un file

Argumento Pro : la corrección del formatting mejorará la calidad general del código.

Argumento de Con : corregir el formatting en una parte irrelevante del file hará que las herramientas te señalen como el autor del código, y las personas que trabajen en la misma pieza después pueden tener la printing equivocada de que lo has creado.

Una herramienta de comparación decente se puede configurar para ignorar el espacio en blanco, no es que esto lo ayude si ha hecho cosas como mover llaves a una nueva línea.

Si yo fuera usted, enviaría dos cambios: uno con la corrección de errores real y otro con el formatting de código corregido.

Debe tener en count que todos tienen un estilo de código ligeramente diferente, y algunos styles no son más correctos o mejores que otros. Habiendo dicho eso, si el código está formateado de una manera verdaderamente horrible, entonces debe solucionarlo: el código con formatting correcto puede ayudar con la debugging y la revisión del código. Se mostrará como el autor de los cambios, pero no debe confundirse con el autor del module en sí; cualquier herramienta de seguimiento de fonts medianamente decente debería mostrar quién escribió qué y cuándo.

Editar:

Lo que estoy defendiendo aquí es que las pequeñas variaciones en el coding style pueden y deben ignorarse: cualquier desarrollador suficientemente experimentado debería ser capaz de leer y comprender el código. El equipo debe tener un enfoque de encoding global unificado, como la cubierta de camello de los nombres de las variables, la encoding correcta de los nombres de los methods, los subrayados de las variables de los miembros, etc., pero el desarrollador individual puede dejar cosas como el formatting de una statement LINQ (a less que sea verdaderamente ilegible). Cuando trabaje en proyectos de código abierto con miembros de diferentes culturas y orígenes, seguramente tendrá diferencias. Usar herramientas como ReSharper puede ayudar a eliminar algunas de estas diferencias, pero en un proyecto comunal no todos tendrán ReSharper (o incluso un IDE medio decente, dependiendo de lo que se esté desarrollando).

Por supuesto, corregir el formatting de las cosas feas, pero no te preocupes por las cosas pequeñas. Los desarrolladores son una combinación de ingeniero, artista y ser humano: obtendrás diferencias. Parte de convertirse en un desarrollador increíble es aprender con qué se puede vivir y qué se debe cambiar.

La regla básica para ser un equipo de desarrollo exitoso es: "Todos deben cumplir con un solo estilo y un solo estilo".

No solo debe corregir el formatting, sino también notificar al autor de ese código: si todos están en la misma página en lo que respecta al coding style, revisar el código escrito por otra persona requiere la mitad del esfuerzo y permite que las personas mantengan el código de los demás bien.