Comment faire une bonne review

Un exercice INGINIOUS s’analyse à deux niveaux. Le premier est le niveau de l’utilisateur. Vous accédez à cet exercice au travers d’INGINIOUS en tant qu’étudiant qui pourrait utiliser cet exercice dans le cadre de ses études. Dans votre review, tentez de répondre aux questions suivantes:

  • L’énoncé est-il clair, et précis ? Pensez à regarder si le contexte est bien présenté. Les spécifications de la fonction à implémenter sont-elles claires et non-ambiguës ? La forme de l’énoncé (grammaire, orthographe) est-elle correcte ? Les exemples proposés facilitent-ils la compréhension de la fonction à écrire ?

  • Le test est-il correct ? Si vous soumettez un code correct, passez-vous tous les tests ? Inversement, si vous soumettez un code incorrect, recevez-vous un message d’erreur

  • Le feedback retourné aux étudiants est-il clair et constructif ? Essayez de tester la tâche INGINIOUS qui vous est proposée avec du code correct (différentes implémentations) et du code contenant différentes erreurs que des étudiants pourraient faire. Comparez le message d’erreur retourné par INGINIOUS et essayez de voir si il serait possible de proposer des améliorations. Dans votre review, fournissez le code source de votre soumission (éventuellement avec l’identifiant INGINIOUS disponible en bas à droite) et le message d’erreur retourné (sous forme texte, le site de review ne permet pas d’envoyer des images)

Le second niveau d’analyse est la suite de test. Analysez les tests unitaires proposés par les étudiants pour cette question INGINIOUS et répondez aux questions suivantes :

  • Le code python proposé est-il clair et bien documenté ?

  • Les noms des variables sont-ils bien choisis ?

  • Les commentaires sont-ils appropriés et clairs ?

  • Les tests montrent-ils qu’ils ont été écrits par des étudiants qui maîtrisent le langage python (utilisation de fonctions, éviter d’avoir trop de code dupliqué, même si dans des tests unitaires il y a plus souvent du code dupliqué que dans le code normal)

  • Si les tests ou le feedback sont incorrects, proposez des améliorations/corrections pour pallier aux erreurs que vous avez identifié

Ces deux niveaux d’analyse prennent du temps, mais c’est important que vous appreniez à lire du code écrit par d’autres informaticiens. Il est peu probable que vous puissiez faire une review détaillée des trois exercices soumis par un groupe en moins d’une heure, à moins que ceux-ci ne soient très mauvais. Dans votre vie professionnelle, vous devrez beaucoup plus souvent modifier des programmes écrits par d’autres informaticiens que de développer des programmes à partir de rien. Il est aussi important que vous appreniez à écrire des commentaires constructifs qui permettent à ceux qui les lisent d’améliorer leur travail.

La review que vous écrivez dans le cadre de ce projet compte dans votre évaluation personnelle. Vous avez donc tout intérêt à la faire correctement. Par contre, votre review n’influence pas la côte qui sera attribuée aux groupes que vous évaluez. Vous les aidez à améliorer leur travail et obtenir une meilleure note mais vous ne leur attribuez pas de note.

Une review de qualité contient les éléments suivants :

  • Au moins deux commentaires positifs sur le travail effectué. Cela comprend :

    • au moins un commentaire sur le fond,

    • au moins un commentaire sur la forme.

  • Au moins deux suggestions d’améliorations possibles. Cela comprend :

    • au moins une suggestion sur le fond, et/ou une suggestion de test unitaire à ajouter pour compléter la suite de test,

    • au moins une suggestion sur la forme.

Évidemment, il s’agit là de l’attente minimale. Vous êtes vivement encouragés à apporter plus d’informations dans votre review, en suivant les conseils plus haut sur cette page !