Comment faire une bonne review

Le projet Ferme des Trois Chênes fera l’objectif d’une review interne au cours, comme nous l’avons fait pour le projet INGInious.

Les reviews sont individuelles : chacun•e d’entre vous va relire le travail d’un groupe entier (càd un site, et environ 4 figures).

Pour effectuer votre review, vous lancez le projet que vous évaluez, en local, via votre installation de Flask, en suivant les instructions fournies dans le readme qui accompagne le projet. Si une erreur survient lors du lancement du projet, demandez-vous si cette erreur est liée à votre installation ou au projet. Si l’erreur est liée au projet ne manquez pas de le noter dans votre review. S’il n’est pas évident de contourner cette erreur, nous vous invitons à effectuer votre review sur base de la version « capture d’écran » du site qui accompagne le projet, tout en le notant dans votre review.

Dans votre review, tentez de répondre aux questions suivantes:

Evaluation du point de vue d’un visiteur qui consulte le site :

  • Pouvez-vous lancer facilement le site à partir des informations fournies dans le readme qui l’accompagne ?

  • Si ce n’est pas le cas, est-il possible de visualiser la version statique du site (captures d’écran) ?

  • Les figures sont-elles accompagnées d’un paragraphe expliquant leur contenu de manière claire et non-ambiguë ? Ce paragraphe peut faire référence aux propositions (cf. Projet 2: Instructions). Nos propositions laissent toutefois une certaine liberté au niveau de la forme et du contenu de chaque figure. Une simple référence à une proposition n’est pas nécessairement suffisant.

  • La forme des explications (grammaire, orthographe) est-elle correcte ?

  • Les figures affichent-t-elles clairement l’information visée ?

Evaluation de l’implémentation :

  • Le code python proposé est-il compréhensible ? (code lisible, clair et bien documenté ? noms des variables sont-ils bien choisis ? Les commentaires sont-ils appropriés et clairs ?)

  • Les requêtes SQL sont-elles lisibles et/ou documentées ?

Ces deux niveaux d’analyse prennent du temps, mais c’est important que vous appreniez à lire du code écrit par d’autres informaticien•ne•s. Il est peu probable que vous puissiez faire une review détaillée du travail 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 informaticien•ne•s 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.