Bonnes pratiques avec un gestionnaire de versions de sources

Que vous utilisiez Subversion, CVS ou tout autre programme pour gérer les versions de vos sources, lorsque vous travaillez en équipe, une certaine discipline s’impose. Voici donc des points importants à suivre et comment les appliquer à chaque utilisation.

Les points importants à suivre sont:

  • Ne mettez pas sur le serveur du code qui ne compile pas. C’est rageant de vouloir tester son propre code et que malheureusement il faut chercher le problème laissé par d’autres personnes. Si vous tenez absolument à mettre votre code non terminé sur le serveur, mettez-le en commentaire pour que le compilateur ne chiale pas.
  • Ne mettez pas les fichiers générés par le makefile ou des compilateurs sur le serveur (ex: *.o *.exe *.dll). Il est clair que les fichiers générés automatiquement seront modifiés chaque fois que vous modifiez du code. Les envoyer sur le serveur prend donc de l’espace inutilement d’autant plus qu’ils peuvent être générés n’importe où.
  • À chaque envoi sur le serveur, il faut mettre un message (commentaire) significatif. Par exemple: le nom de la nouvelle fonctionnalité, la description du bogue réparé, etc.

Les étapes à suivre pour avoir le moins de problèmes possibles:

  1. Avant de commencer à coder, faites une mise à jour des fichiers en vous synchronisant avec le serveur.
  2. Essayez de compiler le code. Si cela ne fonctionne pas, regardez qui a fait des modifications et faites une piñata avec sa tronche.
  3. Modifiez votre code comme bon vous semble.
  4. Essayez de compiler. Cela doit compiler.
  5. Faites une mise à jour des fichiers en vous synchronisant avec le serveur.
  6. S’il y a eu des modifications entre temps, réessayez de compiler. Cela doit compiler.
  7. Envoyer vos modifications sur le serveur avec un commentaire utile.