🎯 Intention

Historiquement chez Captive, nous écrivons le code de nos applications en Français (sauf quelques rares exceptions).

Ce standard vise à expliquer l’ensemble des raisons de pourquoi coder en Français ou en Anglais dans tel ou tel cas.

Il vise aussi à montrer comment nommer les choses dans le code.

✅ Points clés

<aside> ⌛ Temps indicatif :

</aside>

• “La tech au service du produit”, le langage tech employé dans le code doit reprendre exactement le langage du métier afin de faciliter les discutions

  Cela simplifie aussi l’arrivé de nouveau développeur sur un projet car ils peuvent trouver la resource du premier coup et apporter rapidement de la valeur.

Exemple dans Monocle (Le Petit Lunetier) :

Si demain on demande à un développeur d’appliquer une nouvelle fonctionnalité sur les “montures” (de lunette 🥸), il faut d’abord commencer par se demander quel traduction a était utilisé pour le mot Monture. (je vous laisse chercher, moi j’ai mis un moment à trouver 😀)

Exemple : Si le produit parle de “Client”

# ❌ BAD
class Utilisateur
end

# ❌ BAD
class Customer
end

# ✅ GOOD
class Client
end

• Ne pas traduire les librairies On ne cherche pas à traduire les outils et librairies que l’on utilise

• Mot clef et Anglicisme Le produit comme l’équipe tech a tendance à parfois à faire de l’anglicisme, c’est à dire d’utiliser des termes Anglais “API”, “Token”, “Style” (css), … Tout comme l’équipe produit, on utilise alors le même terme même si le mot appartient à la langue anglaise. Il s’agit généralement de mots qui sont plus employés en Anglais que en Français, et qui sont compris par tout le monde. Cela permet ainsi de fluidifier les discutions

• Tout le monde n’est pas bilingue Traduire l’ensemble de la “codebase” requiert parfois un niveau d’Anglais que beaucoup n’ont pas. Ce qui peut provoquer des erreurs et des discussions qui n’ont pas forcément de réponse

  • Traduction US 🇺🇸 vs UK 🇬🇧
  • Mot technique très spécifique à domaine métier qui n’est pas courant : Exemple dans le projet QuelleEnergie, l’équipe à l’époque avait fait le choix d’écrire en anglais, on a donc : accommodation_wall_insulation_thickness Difficile à comprendre n’est ce pas ? 😢 Pour rappel ici, le projet QuelleEnergie est pour la société Effy qui est composé uniquement de personne Française et propose des offres d’isolations uniquement pour des particuliers Français

• Ne pas utiliser d’accent

  La majorité des langages de programmation ne gère pas l’UTF-8. Pour éviter donc tout problème, on enlève l’accent des mots : Intérieur devient Interieur

• Ne pas traduire les “préposition” (de, du, à, chez, …)

# ❌ BAD
IsolationDuMurInterieur

# ✅
IsolationMurInterieur