Comment créer un bon MCVE (exemple vérifiable complet minimal) – Java, SQL et jOOQ.

Online Coding Courses for Kids

Signaler un bug prend du temps, et croyez-moi, chaque fournisseur apprécie votre signalement d’un bug! Votre voix compte autant de voix, pour tous les autres clients d’un produit qui ne veulent pas ou ne peuvent pas prendre le temps de signaler le même bug sont nombreux.

Donc, tout d’abord, merci d’avoir pris ce temps et de nous avoir contactés, fournisseurs. Nous apprécions vraiment votre aide!

Cela dit, signaler un bug peut être un exercice fastidieux. Pour les deux parties, celle signalant le bogue et celle qui le reçoit. Il existe des bogues extrêmement simples, tels que des fautes de frappe dans la documentation. Ils peuvent être facilement pointés et tout aussi facilement fixés. Il existe des bogues beaucoup plus délicats, tels que les problèmes de concurrence dans les configurations de projet complexes. Ils mettent du temps à se reproduire. C’est pourquoi un MCVE (exemple vérifiable complet minimal) est tellement utile. La page de débordement de pile liée explique pourquoi il est si utile de répondre aux questions. Mais les mêmes arguments s’appliquent lors du signalement d’un bogue.

Et c’est là que commence la partie délicate. Il n’est pas facile de créer un exemple qui est:

  • Minimal: Votre code d’application réel est énorme. Vous ne pouvez pas vider l’intégralité de celui-ci au vendeur pour diverses raisons. Et le vendeur ne peut pas parcourir tout cela pour essayer de le reproduire. Ainsi, le problème doit être isolé dans un exemple de portée minimale, sans fonctionnalité supplémentaire inutile. C’est difficile aussi, car votre projet a été mis en place il y a des mois ou des années. Vous ne voulez pas passer trop de temps à mettre en place un nouveau projet
  • Achevée: Lorsque nous réduisons le problème à un minimum, nous sommes tentés de le décrire simplement en prose. Mais cela peut aussi être difficile, car la prose est à peine terminée. Il est difficile de décris un problème quand il serait assez facile d’afficher le code. Mais cela nous ramène à la partie minimale. Nous voulons afficher uniquement le code pertinent, pas tout.
  • Vérifiable: En fin de compte, l’exemple idéal peut être utilisé par le fournisseur pour reproduire le problème, car une fois que cela est possible, le fournisseur peut commencer à le déboguer et à trouver les bons emplacements à corriger assez facilement. Sinon, c’est juste deviner et faire des allers-retours avec le journaliste, juste pour écrire plus de prose. C’est fatigant des deux côtés.

C’est pourquoi nous avons maintenant un exemple de projet sur GitHub pour vous aider à créer ce MCVE:

https://github.com/jOOQ/jOOQ-mcve

C’est un exemple minimal qui utilise:

Cet exemple peut être forké sur GitHub et modifié directement par vous, afin de montrer comment reproduire votre problème. À l’avenir, nous ajouterons d’autres exemples de configurations qui peuvent être utiles pour reproduire votre problème spécifique.

Merci encore d’avoir pris le temps de signaler les problèmes. Nous les vendeurs apprécions vraiment votre travail!

Close Menu