Code review sous GitLab

L’objectif de ce TP est d'expérimenter le code reviewing, c'est-à-dire la relecture et l'évaluation du code par les pairs. Vous jouerez les deux rôles : relecteur et développeur pour un autre projet.

Mise à jour des propriétés du projet sous GitLab

Exercice 1:

Dans l'UI de GitLab, vérifiez que la visibilité de votre projet est sur 'private'.

Exercice 2:

Ajoutez la personne qui sera votre binôme pour cet exercice, en tant que membre du projet avec le rôle développeur. Vous trouverez les associations dans le fichier suivant : affectations du code review par groupe. Si votre binôme n'est pas présent, associez vous au projet de quelqu'un qui se sent assez à l'aise pour effectuer deux relectures de code, de fait elle aura droit à deux relectures de son propre code.

Récupération du projet auquel vous êtes associé

Exercice 3:

L'objectif est donc d'évaluer le projet de votre binôme, puis de proposer des merge request en conséquence. Vous allez donc tout d'abord cloner le projet de votre binôme. Faites le fonctionner pour vérifier sa mise en place.

Postez votre appréciation globale dans GitLab

Exercice 4:

Postez vos remarques les plus globales en créant une issue dans GitLab. Vos commentaires doivent se focaliser sur la lisibilité du code : est-il facilement compréhensible ? Est-il documenté : pourriez-vous facilement faire une autre version en utilisant la JavaDoc ? Vous pouvez aussi faire des remarques sur les aspects de conception.

Refactoring et création de merge requests

Exercice 5:

Créer une nouvelle branche pour commencer à travailler sur le code. Pour cette session, vous allez proposer des améliorations classe par classe. L'idée est de créer une branche à chaque fois que vous démarrer sur une nouvelle classe. Faites les modifications qui vous semblent pertinentes puis faites un commit puis un push. Inititez ensuite une merge request de votre branche dans la branche main. Vous pouvez le faire depuis l'interface de GitLab, ou bien utiliser l'adresse donnée dans le terminal lors de votre dernier push.

Exercice 6:

Lors de la création de la merge request dans l'interface de GitLab, ajoutez votre binôme en tant que 'reviewer'.

Exercice 7:

Prévenez ensuite votre binôme qu'il y a une MR à évaluer : il est libre d'ajouter des commentaires nécessitant des changements avant l'acceptation. Si c'est le cas, faites les modifications demandées et faites un nouveau push sur votre branche : cela mettra à jour la MR. Et ainsi de suite.