Conventions back-end

Python

Le code Python est utilisé pour certains paquets et pour les tests d’intégration.

• Suivez le Zen of Python.
• Le code est linté avec flake8.
• Le code est formaté avec Black.
• Les imports sont triées avec Isort.
• Les tests sont écrits avec pytest.
• Les types sont vérifiés avec pytype.

Rust

• Comme référence pour le développement de notre API, nous utilisons les Rust API guidelines. D’une manière générale, il convient de les respecter.
• Préférer les importations granulaires aux importations globales comme diesel::*.
• Les tests sont écrits avec le framework de base.
• Utilisez l’exemple de documentation pour savoir comment formuler et formater votre documentation.
• Utilisez un style de commentaire cohérent :
  • /// les commentaires de la documentation sont au-dessus des invocations #[derive(Trait)].
  • Les commentaires // doivent généralement être placés au-dessus de la ligne en question, plutôt qu’en ligne.
  • Les commentaires commencent par des lettres majuscules. Terminez-les par un point s’ils ressemblent à une phrase.
• Utilisez les commentaires pour organiser des portions de code longues et complexes qui ne peuvent être raisonnablement remaniées en fonctions distinctes.
• Le code est linté avec clippy.
• Le code est formaté avec fmt.

Java

• Le code est formaté avec checkstyle.