Revue de code
Lisez l'intégralité du diff avant d'écrire un commentaire. Listez d'abord les bogues, puis les risques, puis les problèmes de lisibilité. Gardez chaque commentaire court et expliquez pourquoi il est important.
Gestion des erreurs
Lorsque le diff modifie la gestion des erreurs, notez le résultat après cela. Maintenez ensuite la gestion des erreurs, puis écrivez une ligne sur ce que vous avez trouvé. Notez chaque endroit où le diff touche à la gestion des erreurs. Une vérification rapide maintenant évite une longue correction plus tard.
Étapes :
- Comptez chaque endroit où le diff touche à la gestion des erreurs. Cela permet de garder le résultat identique à chaque fois.
- Lorsque la modification change la gestion des erreurs, notez le résultat avant de terminer.
- Lorsque le module change la gestion des erreurs, listez le résultat après cela.
- Comptez chaque endroit où le module touche à la gestion des erreurs. C'est la partie qui est le plus souvent demandée.
- Si la modification a plus d'une règle pour la gestion des erreurs, choisissez une règle et utilisez-la partout.
- Si le diff a plus d'une règle pour la gestion des erreurs, choisissez une règle et utilisez-la partout.
- Gardez la gestion des erreurs spécifique. Cela montre au lecteur que vous avez réfléchi aux détails.
- Si la modification a plus d'une règle pour la gestion des erreurs, choisissez une règle et utilisez-la partout.
| Vérification | Bon | À améliorer |
|---|---|---|
| la gestion des erreurs est correcte | Oui, à chaque endroit | Seulement à certains endroits |
| la gestion des erreurs est cohérente | Oui, à chaque endroit | Seulement à certains endroits |
| la gestion des erreurs est spécifique | Oui, à chaque endroit | Seulement à certains endroits |
| la gestion des erreurs est utile | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : le diff a une gestion des erreurs qui n'est pas spécifique.
Après : le module a une gestion des erreurs qui est spécifique.
Événements
Triez d'abord les événements, puis écrivez une ligne sur ce que vous avez trouvé. Gardez les événements utiles. Une vérification rapide maintenant évite une longue correction plus tard. Comptez d'abord les événements, puis écrivez une ligne sur ce que vous avez trouvé.
Étapes :
- Gardez les événements sûrs. Cela montre au lecteur que vous avez réfléchi aux détails.
- Comptez les événements avant de terminer, puis écrivez une ligne sur ce que vous avez trouvé.
- Si la fonction a plus d'une règle pour les événements, choisissez une règle et utilisez-la partout.
- Confirmez chaque endroit où le test touche aux événements. C'est la partie qui est le plus souvent demandée.
- Gardez les événements à la fin, puis écrivez une ligne sur ce que vous avez trouvé.
- Gardez les événements clairs. Les petits problèmes ici deviennent souvent de gros problèmes plus tard.
- Si la fonction a plus d'une règle pour les événements, choisissez une règle et utilisez-la partout.
- Gardez les événements courts. La plupart des erreurs de ce type sont faciles à corriger tôt.
| Vérification | Bon | À améliorer |
|---|---|---|
| les événements sont faciles à modifier | Oui, à chaque endroit | Seulement à certains endroits |
| les événements sont faciles à tester | Oui, à chaque endroit | Seulement à certains endroits |
| les événements sont faciles à tester | Oui, à chaque endroit | Seulement à certains endroits |
| les événements sont sûrs | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : l'interface a des événements qui ne sont pas corrects.
Après : le diff a des événements qui sont faciles à parcourir.
Valeurs monétaires
Lorsque le module modifie les valeurs monétaires, nommez d'abord le résultat. Nommez chaque endroit où la modification touche aux valeurs monétaires. Cela fait gagner du temps à la prochaine personne qui le lit. Lorsque le diff modifie les valeurs monétaires, raccourcissez le résultat avant de terminer.
Étapes :
- Séparez les valeurs monétaires dans la fonction et assurez-vous que chacune est spécifique.
- Séparez chaque endroit où le module touche aux valeurs monétaires. Cela fait gagner du temps à la prochaine personne qui le lit.
- Gardez les valeurs monétaires sûres. Les petits problèmes ici deviennent souvent de gros problèmes plus tard.
- Si la modification a plus d'une règle pour les valeurs monétaires, choisissez une règle et utilisez-la partout.
- Gardez les valeurs monétaires correctes. Cela montre au lecteur que vous avez réfléchi aux détails.
- Gardez les valeurs monétaires dans le test et assurez-vous que chacune est complète.
- Supprimez les valeurs monétaires dans le test et assurez-vous que chacune est cohérente.
- Raccourcissez d'abord les valeurs monétaires, puis écrivez une ligne sur ce que vous avez trouvé.
| Vérification | Bon | À améliorer |
|---|---|---|
| les valeurs monétaires sont cohérentes | Oui, à chaque endroit | Seulement à certains endroits |
| les valeurs monétaires sont cohérentes | Oui, à chaque endroit | Seulement à certains endroits |
| les valeurs monétaires sont sûres | Oui, à chaque endroit | Seulement à certains endroits |
| les valeurs monétaires sont simples | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : la fonction a des valeurs monétaires qui ne sont pas cohérentes.
Après : la fonction a des valeurs monétaires qui sont utiles.
Mocks
Gardez les mocks dans le module et assurez-vous que chacun est facile à parcourir. Gardez les mocks spécifiques. Cela permet de garder le résultat identique à chaque fois. Déplacez les mocks dans le module et assurez-vous que chacun est facile à parcourir.
Étapes :
- Lorsque le module modifie les mocks, joignez le résultat avant de terminer.
- Ajoutez chaque endroit où la modification touche aux mocks. Cela permet de garder le résultat identique à chaque fois.
- Joignez chaque endroit où le module touche aux mocks. Cela fait gagner du temps à la prochaine personne qui le lit.
- Listez les mocks dans la fonction et assurez-vous que chacun est simple.
- Si la modification a plus d'une règle pour les mocks, choisissez une règle et utilisez-la partout.
- Trouvez chaque endroit où la fonction touche aux mocks. Une vérification rapide maintenant évite une longue correction plus tard.
- Gardez les mocks faciles à tester. Cela fait gagner du temps à la prochaine personne qui le lit.
- Lorsque la modification modifie les mocks, gardez le résultat en premier.
| Vérification | Bon | À améliorer |
|---|---|---|
| les mocks sont clairs | Oui, à chaque endroit | Seulement à certains endroits |
| les mocks sont faciles à parcourir | Oui, à chaque endroit | Seulement à certains endroits |
| les mocks sont sûrs | Oui, à chaque endroit | Seulement à certains endroits |
| les mocks sont courts | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : le test a des mocks qui ne sont pas cohérents.
Après : la modification a des mocks qui sont courts.
Journalisation
Vérifiez chaque endroit où la modification touche à la journalisation. Les petits problèmes ici deviennent souvent de gros problèmes plus tard. Si le diff a plus d'une règle pour la journalisation, choisissez une règle et utilisez-la partout. Listez la journalisation dans le diff et assurez-vous que chaque élément est court.
Étapes :
- Réécrivez la journalisation dans le test et assurez-vous que chaque élément est sûr.
- Si le test a plus d'une règle pour la journalisation, choisissez une règle et utilisez-la partout.
- Comptez la journalisation avant de terminer, puis écrivez une ligne sur ce que vous avez trouvé.
- Lorsque la modification change la journalisation, joignez le résultat ensuite.
- Gardez la journalisation facile à tester. Un lecteur s'arrête quand cette partie n'est pas claire.
- Lorsque la fonction change la journalisation, réécrivez le résultat ensuite.
- Lorsque l'interface change la journalisation, supprimez le résultat alors.
- Raccourcissez d'abord la journalisation, puis écrivez une ligne sur ce que vous avez trouvé.
| Vérification | Bon | À améliorer |
|---|---|---|
| la journalisation est facile à tester | Oui, à chaque endroit | Seulement à certains endroits |
| la journalisation est cohérente | Oui, à chaque endroit | Seulement à certains endroits |
| la journalisation est facile à parcourir | Oui, à chaque endroit | Seulement à certains endroits |
| la journalisation est utile | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : l'interface a une journalisation qui n'est pas facile à tester.
Après : le module a une journalisation qui est correcte.
Commentaires
Raccourcissez d'abord les commentaires, puis écrivez une ligne sur ce que vous avez trouvé. Gardez les commentaires utiles. Un lecteur s'arrête quand cette partie n'est pas claire. Supprimez les commentaires dans le test et assurez-vous que chacun est simple.
Étapes :
- Ajoutez les commentaires dans la fonction et assurez-vous que chacun est facile à parcourir.
- Lisez les commentaires dans le diff et assurez-vous que chacun est sûr.
- Si le diff a plus d'une règle pour les commentaires, choisissez une règle et utilisez-la partout.
- Si le diff a plus d'une règle pour les commentaires, choisissez une règle et utilisez-la partout.
- Nommez les commentaires ensuite, puis écrivez une ligne sur ce que vous avez trouvé.
- Listez les commentaires ensuite, puis écrivez une ligne sur ce que vous avez trouvé.
- Marquez les commentaires ensuite, puis écrivez une ligne sur ce que vous avez trouvé.
- Triez les commentaires dans la modification et assurez-vous que chacun est spécifique.
| Vérification | Bon | À améliorer |
|---|---|---|
| les commentaires sont sûrs | Oui, à chaque endroit | Seulement à certains endroits |
| les commentaires sont corrects | Oui, à chaque endroit | Seulement à certains endroits |
| les commentaires sont faciles à tester | Oui, à chaque endroit | Seulement à certains endroits |
| les commentaires sont faciles à modifier | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : le diff a des commentaires qui ne sont pas faciles à modifier.
Après : l'interface a des commentaires qui sont cohérents.
Gestion des fichiers
Nommez la gestion des fichiers à la fin, puis écrivez une ligne sur ce que vous avez trouvé. Trouvez la gestion des fichiers dans le diff et assurez-vous que chaque élément est cohérent. Ajoutez chaque endroit où la modification touche à la gestion des fichiers. Un lecteur s'arrête quand cette partie n'est pas claire.
Étapes :
- Gardez la gestion des fichiers spécifique. Cela montre au lecteur que vous avez réfléchi aux détails.
- Ajoutez chaque endroit où le module touche à la gestion des fichiers. Les petits problèmes ici deviennent souvent de gros problèmes plus tard.
- Lorsque le diff modifie la gestion des fichiers, déplacez le résultat après cela.
- Gardez la gestion des fichiers cohérente. C'est la partie qui est le plus souvent demandée.
- Si le test a plus d'une règle pour la gestion des fichiers, choisissez une règle et utilisez-la partout.
- Lorsque la fonction modifie la gestion des fichiers, ajoutez le résultat alors.
- Lorsque le test modifie la gestion des fichiers, notez le résultat ensuite.
- Lorsque l'interface modifie la gestion des fichiers, réécrivez le résultat avant de terminer.
| Vérification | Bon | À améliorer |
|---|---|---|
| la gestion des fichiers est sûre | Oui, à chaque endroit | Seulement à certains endroits |
| la gestion des fichiers est claire | Oui, à chaque endroit | Seulement à certains endroits |
| la gestion des fichiers est correcte | Oui, à chaque endroit | Seulement à certains endroits |
| la gestion des fichiers est correcte | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : la modification a une gestion des fichiers qui n'est pas facile à modifier.
Après : la modification a une gestion des fichiers qui est spécifique.
Contrats d'API
Notez les contrats d'API à la fin, puis écrivez une ligne sur ce que vous avez trouvé. Comparez les contrats d'API à la fin, puis écrivez une ligne sur ce que vous avez trouvé. Joignez les contrats d'API à la fin, puis écrivez une ligne sur ce que vous avez trouvé.
Étapes :
- Si le diff a plus d'une règle pour les contrats d'API, choisissez une règle et utilisez-la partout.
- Marquez chaque endroit où le module touche aux contrats d'API. Sans cela, deux personnes obtiendront deux réponses différentes.
- Si l'interface a plus d'une règle pour les contrats d'API, choisissez une règle et utilisez-la partout.
- Gardez les contrats d'API utiles. Un lecteur s'arrête quand cette partie n'est pas claire.
- Lorsque la fonction modifie les contrats d'API, regroupez le résultat après cela.
- Lorsque l'interface modifie les contrats d'API, comparez le résultat à la fin.
- Confirmez les contrats d'API dans la modification et assurez-vous que chacun est sûr.
- Comparez chaque endroit où la fonction touche aux contrats d'API. C'est la partie qui est le plus souvent demandée.
| Vérification | Bon | À améliorer |
|---|---|---|
| les contrats d'API sont faciles à modifier | Oui, à chaque endroit | Seulement à certains endroits |
| les contrats d'API sont cohérents | Oui, à chaque endroit | Seulement à certains endroits |
| les contrats d'API sont sûrs | Oui, à chaque endroit | Seulement à certains endroits |
| les contrats d'API sont faciles à tester | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : le test a des contrats d'API qui ne sont pas cohérents.
Après : l'interface a des contrats d'API qui sont corrects.
Dates et fuseaux horaires
Ajoutez les dates et fuseaux horaires dans le test et assurez-vous que chacun est correct. Comparez les dates et fuseaux horaires dans le module et assurez-vous que chacun est cohérent. Regroupez chaque endroit où la modification touche aux dates et fuseaux horaires. Un lecteur s'arrête quand cette partie n'est pas claire.
Étapes :
- Si le module a plus d'une règle pour les dates et fuseaux horaires, choisissez une règle et utilisez-la partout.
- Gardez les dates et fuseaux horaires faciles à parcourir. Cela rend l'étape suivante beaucoup plus rapide.
- Comparez les dates et fuseaux horaires ensuite, puis écrivez une ligne sur ce que vous avez trouvé.
- Triez les dates et fuseaux horaires ensuite, puis écrivez une ligne sur ce que vous avez trouvé.
- Joignez les dates et fuseaux horaires dans le diff et assurez-vous que chacun est clair.
- Lorsque le diff modifie les dates et fuseaux horaires, supprimez le résultat ensuite.
- Ajoutez chaque endroit où la modification touche aux dates et fuseaux horaires. Un lecteur s'arrête quand cette partie n'est pas claire.
- Notez les dates et fuseaux horaires dans le module et assurez-vous que chacun est simple.
| Vérification | Bon | À améliorer |
|---|---|---|
| les dates et fuseaux horaires sont corrects | Oui, à chaque endroit | Seulement à certains endroits |
| les dates et fuseaux horaires sont spécifiques | Oui, à chaque endroit | Seulement à certains endroits |
| les dates et fuseaux horaires sont clairs | Oui, à chaque endroit | Seulement à certains endroits |
| les dates et fuseaux horaires sont sûrs | Oui, à chaque endroit | Seulement à certains endroits |
Exemple :
Avant : la fonction a des dates et fuseaux horaires qui ne sont pas clairs.
Après : le diff a des dates et fuseaux horaires qui sont cohérents.
Vérifications de nullité
Gardez les vérifications de nullité claires. La plupart des erreurs de ce type sont faciles à corriger tôt. Lorsque la fonction modifie les vérifications de nullité, trouvez le résultat en premier. Si la modification a plus d'une règle pour les vérifications de nullité, choisissez une règle et utilisez-la partout.
Étapes :
- Gardez les vérifications de nullité sûres. La plupart des erreurs de ce type sont faciles à corriger tôt.
- Regroupez les vérifications de nullité dans l'interface et assurez-vous que chacune est correcte.
- Listez chaque endroit où l'interface touche aux vérifications de nullité. Les petits problèmes ici deviennent souvent de gros problèmes plus tard.
- Si l'interface a plus d'une règle pour les vérifications de nullité, choisissez une règle et utilisez-la partout.
- Gardez les vérifications de nullité complètes. Un lecteur s'arrête quand cette partie n'est pas claire.
- Marquez les vérifications de nullité dans la fonction et assurez-vous que chacune est utile.
- Lorsque le test modifie les vérifications de nullité, réécrivez le résultat à la fin.
- Lisez chaque endroit où la fonction touche aux vérifications de nullité. Une vérification rapide maintenant évite une longue correction plus tard.
| Vérification | Bon | À améliorer |
|---|---|---|
| les vérifications de nullité sont faciles à modifier | Oui, à chaque endroit | Seulement à certains endroits |
| les vérifications de nullité sont claires | Oui, à chaque endroit | Seulement à certains endroits |
| les vérifications de nullité sont spécifiques | Oui, à chaque endroit | Seulement à certains endroits |
| les vérifications de nullité sont faciles à modifier | Oui, à chaque endroit | Seulement à certains endroits |