1. Generals rules¶
Sont ici données quelques consignes que tout développeur Aero-Webb doit connaitre et garder en mémoire.
1.1 Responsabilité¶
Chaque développeur est responsable des outils de développement qu'il installe sur son poste et, à ce titre, il les maintient à jour régulièrement :
- IDE (VS Code, Eclipse ou Intellij Idea)
- Sourcetree, Git Bash
- ...
1.2 IDE¶
Les IDE officiellement autorisés à être installés sur leur poste par les développeurs Aero-Webb sont :
- pour le backend :
- Eclipse,
- VS Code,
- JetBrains IntelliJ Idea (dans sa version communautaire) ;
- pour le frontend :
Sauf autre précision, il est conseillé de choisir la version la plus récente disponible au moment de l'installation.
1.3 Autres outils¶
La documentation d'installation du poste de développement présente certains outils à installer, mais si un développeur souhaite en installer d'autres, en complément ou en remplacement de ceux proposés (IDE, outil de SCM, comme TortoiseGit par exemple, ou autres), il doit alors en demander l'autorisation auprès de l'équipe Backend Transverse, dirigée par Marc et Jonathan.
1.4 Docker Desktop¶
Historiquement, afin de pouvoir exécuter les tests unitaires portant sur la couche DAO, les développeurs backend d'Aero-Webb avaient pour habitude d'installer l'outil Docker Desktop, sur lequel s'appuie le framework java Testcontainers pour créer une base de données temporaire le temps de l'exécution des tests unitaires.
Toutefois, suite à un changement de licence de Docker Desktop, intervenu le 31/08/2021, qui a rendu cet outil payant dans un contexte d'utilisation commerciale (cf. https://www.docker.com/pricing/, en bas de page), il est depuis recommandé de ne plus l'utiliser, voire le désinstaller le cas échéant.
A la place, il est conseillé de suivre la procédure de configuration de Docker et Testcontainers sous WSL.
1.5 Merge Request¶
- Les procédures à suivre pour créer une merge request sont accessibles via le lien suivant :
https://2moro.gitlab.io/aero-webb/documentation/Common/How-toes/create-merge-request/
- Les procédures à suivre pour relire une merge request sont accessibles via le lien suivant :
https://2moro.gitlab.io/aero-webb/documentation/Common/How-toes/review-merge-request/
1.6 Utilisation des outils d'IA¶
Consigne du groupe SOPRA à appliquer :
A ce stade et au vu des connaissances actuelles et de la position de nos clients, il est formellement interdit d’utiliser ces outils d’IA dite générative ChatGPT ou Github Copilot (liste non exhaustive).
Le groupe interdit donc l’utilisation de ces outils d’IA pour la génération/optimisation de code.
Le problème est principalement de deux ordres :
- La fuite de données sensibles et, dans notre cas, soumettre une partie du code Aero-Webb ou Aero One pour faire générer du code qui peut donner des informations aux propriétaires de ces outils et à la concurrence.
- Le code généré ne doit pas être pris au pied de la lettre (potentielles failles et vulnérabilités) et transposé dans des applications sans une bonne relecture par un développeur confirmé.
Merci donc de respecter cette consigne.
Pour plus de détail, consultez ce document.
Même si ce document parle des développements SAP, son périmètre s’étend bien à tout développement logiciel au sein du groupe et les produits 2MoRO en particulier.
Created: 2024-01-30