32 votes

Dois-je engager des changements cosmétiques?

Il y a des mineurs de codage des changements de style que j'ai souvent envie de s'engager pour le contrôle de code source, mais maintenant, le journal des modifications est pleine de ces changements qui n'affectent pas la fonctionnalité de code.

Que dois-je faire la prochaine fois que je dois corriger les petites choses comme:

  • Supprimer et trier de l'usage (en .NET, les importations en python, comprend en c++)
  • D'indentation, les espaces et les sauts de ligne

31voto

Alex Brown Points 15776

Si vous modifiez le fichier de code, je ne vois vraiment pas pourquoi vous ne voulez pas à s'engager et à faire part de ces changements. Si vous ne courez-vous pas le risque que quelqu'un d'autre va les corriger et ensuite entrer en collision avec la vôtre.

Si ils ne sont pas les changements que d'autres veulent les utilisateurs dans la base de code, peut-être que vous devriez vous demander pourquoi vous passez du temps à les écrire.

25voto

moonshadow Points 28302

Faire valider, avec la validation des commentaires marqués de manière appropriée pour le rendre plus facile à ignorer lors de l'écrémage par le biais d'une liste de modifications.

Ne pas s'engager dans la même opération comme une modification de la fonctionnalité. De cette façon, si vous cassez quelque chose, il est plus facile d'affiner ce qu'elle a éclaté et il est facile de revenir juste le refactoring si nécessaire.

22voto

Peter Lang Points 25877

Ne pas s'engager avec sans rapport avec les correctifs.

Je voudrais de les valider, mais ajouter quelques modes de mot-clé pour le message de commit. Les Messages avec ce mot-clé peut alors être ignoré lors de la génération des journaux de modifications.

Vous pouvez utiliser un préfixe comme [cleanup] par exemple.

[cleanup] Removed some whitespace
[cleanup] Changed format
Fixed some major bug.
[cleanup] Corrected indentation

6voto

Len Holgate Points 12579

Sur des projets où je suis le seul développeur, j'ai tendance à faire ce genre de fix-ups le long de avec d'autres modifications de code.

Sur des projets où il y a une équipe de nous, j'ai tendance à essayer et valider ces changements sur leur propre afin de ne pas masquer le "vrai travail".

Je pense qu'il est important de corriger tout ce qui est "mal", avec une base de code, même si c'est purement choses mineures comme l'indentation.

5voto

Anne Schuessler Points 1092

Je pense que cela dépend de votre environnement de travail et comment les autres travaillent sur le même projet voulez traiter avec ce qui est susceptible de varier.

Donc, ma suggestion serait de demander aux gens de travailler avec le même code et à venir avec une ligne directrice pour les cas comme ça. Vous trouverez peut-être que les gens n'ont pas l'esprit de check-ins en raison des changements cosmétiques ou qu'il serait préférable de vivre avec un peu de "unprettiness" plutôt que de traiter avec encombré les journaux du changement.

Une ligne directrice définitive qui est transparent pour tout le monde est la meilleure façon de traiter ces questions et d'éviter toute confusion à l'avenir.

Personnellement, j'aime bien rangé code et ne me dérangerait pas de check-ins en raison purement changements cosmétiques. Toutefois, si elle est juste un peu d'espacement et les sauts de ligne, je serais probablement que de laisser faire et de ne modifier que si je travaillais sur le même fichier de code de toute façon. J'ai souvent supprimer et trier les utilise parce que je trouve déroutant si il y a tout un tas d'usage qui n'ont pas de sens, mais c'est juste moi.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X