search

DavidFrancois / ToDo

School VueJS Project. Development stopped before getting to a viable version.
0 stars 0 forks source link

Remarques finales #7

Closed ViBiOh closed 7 years ago

ViBiOh commented 7 years ago

ToDo

Git

Utilisation un peu confuse des branches dans Git. Les commentaires des commits sont parfois redondants (e.g. 14 commits en séquence pour "add test travis"). Pensez à mettre des commentaires explicites pour vous y retrouver.

Vous avez laissé node_modules sur votre repo alors que je vous ai indiqué à deux reprises de l'enlever. Vous n'avez pas à stocker vos dépendances sur votre repository (sauf dans de très très rares cas) : on ne stocke que le code qui appartient au projet.

Documentation

Le README est inachevé, la première ligne indique ce à quoi il "devrait" ressembler. Les user-story sont assez complètes mais compte-tenu de ce qui a été présenté, quelle est la partie fonctionelle parmi cette liste ?

Vous avez bâclé le dossier de synthèse, c'est vraiment dommage. Pas une page de présentation ou un titre rappelant les membres de l'équipe, le projet et l'objet du document. C'est le document qui résume votre projet et que je lis en dernier. Vos retours sont intéressants, notamment la "trop bonne ambiance" qui a freiné votre progression. Pensez à argumenter les choix de technologies : pourquoi VueJS, pourquoi Mongo ?

Le contenu est de la synthèse est là, sans trop de fautes d'orthographe relevées, bon point, vous vous êtes relus. Il aurait mérité un peu plus de soin au niveau de la mise en forme

Code

Attention à faire le ménage dans votre code. Il subsiste pas mal de commentaires de "désactivation" de code (e.g. toDoFront/src/services/auth.js, toDoApi/app/models/user/statics.js ou encore toDoFront/src/components/lists/Task.vue#36). Bonne séparation entre les composants, les services et les vues côté front. On pourrait améliorer en faisant un dossier "view" avec les vues, afin de ne pas les avoir dans le dossier "components".

Bien d'avoir isolé chaque concept de l'application côté back (config / controllers / services / models). L'application respecte très bien les concepts du SRP. Chaque dossier est structuré de façon identique afin d'être exporté en une seule fois en agrégeant l'ensemble des fichiers.

Attention à utiliser des outils d'analyse statique de code, comme ESlint. Il est conseillé de toujours mettre les accolades autour des instructions de contrôle (if, for, etc.). Le fichier server.js devrait se trouver dans le dossier /app, à la racine car sans ça on ne voit pas très bien le point d'entrée lorsque l'on arrive dans le dossier app.

Tests

Les tests sont au final des tests d'intégration : il faut un serveur qui répond et ne sont pas très nombreux (7 !). Il y a un test unitaire qui est visiblement une duplication des autres tests (beaucoup de variable inutiles).

Conclusion

Equipe et projet intéressant : les ToDo sont souvent les applications exemples des frameworks, il n'est donc pas anodin de découvrir des technologies sur ce type de projet. Vous vous êtes un peu éparpillés lors de la réalisation du projet ce qui donne un aspect assez brouillon. Néanmoins, vous avez essayé la panoplie complète des outils que je suggérais (sans qu'aucun ne soit pleinement réussi) et malgré une application non fonctionnelle, il est bon de tester les outils.

Vous étiez un groupe très vivant et avec une bonne prise de parole. Attention toutefois à ne pas la monopoliser, vous étiez aussi le groupe le plus bruyant. Vos présentations étaient plutôt centrées sur le Javascript (l'ensemble de votre code) et avez tous, à tour de rôle, fait un bon tour d'horizon des outils utilisés.

Shenrak commented 7 years ago

Je crois que c'est la première fois que je vois un retour aussi détaillé sur un projet qu'on a fait dans cet IUT. Merci de ce retour !