Vitam - Contributions [fr]

Formatage du code

2024-06-03T14:39:45Z

Ebernard :

== Code Java ==

Le plugin maven [https://github.com/diffplug/spotless/tree/main/plugin-maven Spotless] est activé pour le formatage du code Java. Ce plugin permet de reformater en utilisant [https://github.com/jhipster/prettier-java prettier-java] et se charge également d'optimiser les imports.

Il peut être exécuté de deux façons différentes :
* vérification (<code>mvn spotless:check</code>) : vérifie que le code respecte le formatage recommandé par prettier-java. Si ce n'est pas le cas, le build maven va échouer. Ce mode est automatiquement appliqué dans la phase <code>verify</code> de maven, et sert notamment dans le build jenkins.
* reformatage automatique (<code>mvn spotless:apply</code>) : applique automatiquement le bon format aux différents fichiers. Attention, cette commande va évidemment modifier les fichiers. Cela dit, je n'ai jamais eu de problème, mais partir du principe que cela ne marchera correctement que si le code compile.

Le code style de Vitam a été modifié pour le rendre compatible (le plus possible, ce n'est malheureusement pas parfait). Télécharger et activer le nouveau code style depuis [https://assistance.programmevitam.fr/plugins/docman/download/152/1 ici].

Il existe un plugin IntelliJ permettant de lancer le reformatage avec Spotless depuis l'IDE. Le plugin s'appelle [https://plugins.jetbrains.com/plugin/22455-spotless-applier Spotless Applier].

Tout ceci s'applique à Vitam Core et à Vitam UI.

== Code TypeScript ==

De la même façon que pour le code java, [https://prettier.io/ Prettier] est installé et configuré pour le code TypeScript de Vitam UI.

De la même façon que pour le code Java, il peut être utilisé de deux façons différentes :
* vérification (<code>npm run prettier:ci</code>). Vérifie que le code respecte le formatage attendu, échoue dans le cas contraire. Exécuté notamment dans le build jenkins
* reformatage (<code>npm run prettier</code>). Reformate le code selon les règles de Prettier.

Il existe aussi un plugin IntelliJ (nommé "Prettier") pour exécuter Prettier automatiquement à l'enregistrement d'un fichier. La configuration recommandée est la suivante, dans Languages & Frameworks > JavaScript > Prettier :
* Automatic Prettier Configuration
* Run for files : laisser par défaut
* Run on save

Formatage du code

2024-06-03T14:30:58Z

Ebernard : Page créée avec « == Code Java == Le plugin maven [https://github.com/diffplug/spotless/tree/main/plugin-maven Spotless] est activé pour le formatage du code Java. Ce plugin permet de reformater en utilisant [https://github.com/jhipster/prettier-java prettier-java] et se charge également d'optimiser les imports. Il peut être exécuté de deux façons différentes : * vérification (<code>mvn spotless:check</code>) : vérifie que le code respecte le formatage recommandé par p... »

== Code Java ==

Le plugin maven [https://github.com/diffplug/spotless/tree/main/plugin-maven Spotless] est activé pour le formatage du code Java. Ce plugin permet de reformater en utilisant [https://github.com/jhipster/prettier-java prettier-java] et se charge également d'optimiser les imports.

Il peut être exécuté de deux façons différentes :
* vérification (<code>mvn spotless:check</code>) : vérifie que le code respecte le formatage recommandé par prettier-java. Si ce n'est pas le cas, le build maven va échouer. Ce mode est automatiquement appliqué dans la phase <code>verify</code> de maven, et sert notamment dans le build jenkins.
* reformatage automatique (<code>mvn spotless:apply</code>) : applique automatiquement le bon format aux différents fichiers. Attention, cette commande va évidemment modifier les fichiers. Cela dit, je n'ai jamais eu de problème, mais partir du principe que cela ne marchera correctement que si le code compile.

Le code style de Vitam a été modifié pour le rendre compatible (le plus possible, ce n'est malheureusement pas parfait). Télécharger et activer le nouveau code style depuis [https://assistance.programmevitam.fr/plugins/docman/download/152/1 ici].

Il existe un plugin IntelliJ permettant de lancer le reformatage avec Spotless depuis l'IDE. Le plugin s'appelle [https://plugins.jetbrains.com/plugin/22455-spotless-applier Spotless Applier].

Tout ceci s'applique à Vitam Core et à Vitam UI.

== Code TypeScript ==

De la même façon que pour le code java, [https://prettier.io/ Prettier] est installé et configuré pour le code TypeScript de Vitam UI.

De la même façon que pour le code Java, il peut être utilisé de deux façons différentes :
* vérification (<code>npm run prettier:ci</code>). Vérifie que le code respecte le formatage attendu, échoue dans le cas contraire. Exécuté notamment dans le build jenkins
* reformatage (<code>npm run prettier</code>). Reformate le code selon les règles de Prettier.

Il existe aussi un plugin IntelliJ (nommé "Prettier") pour exécuter Prettier automatiquement à l'enregistrement d'un fichier. La configuration recommandée est la suivante :
[[File:config prettier.png|406px|Configuration du plugin Prettier]]

MULTITEAM

2024-06-03T14:29:49Z

Ebernard : /* Procédures */

== Présentation de l'équipe ==

- GHERIBI Lotfi

- RADEAU Daniel

- BERTOUL Raouaa

- SERIR Soufyane

- LEMAIRE Sandrine

- MINY Jean-Marie

- BERNARD Etienne

- TIZAOUI Mohamed

- BENARBIA Benaissa

- PARIS Alexandre

- NAJI Hossame

- ROBERT Maxime

- FATAN Souhaib

- JOSSE Isabelle

- VILLE Marion

- WELLHOFF Leo

[https://osmose.numerique.gouv.fr/jcms/p_2694773/fr/vitam-trombi Trombinoscope]

[https://docs.google.com/spreadsheets/d/12s-rlw3YEukqnjHTh9Kb9FhRfzY2J3hHdP81LBu_oHY/edit?pli=1#gid=0 Tableau de suivi des présences (Global)]

[https://docs.google.com/spreadsheets/d/1PiE6gQ2yFORZNtOYhkFugdmnMbPHhFdfCXapw5E-O6c/edit#gid=0 Planning Qualification Support]

== Procédures ==

[[Création d'une MR / PR]]

[[Review d'une MR / PR]]

[[Procédure d'installation Vitam Core pour développement local v.1.0]]

[[Formatage du code]]

== DOR : Definition Of Ready ==

* Estimation et criticité doivent être définie
* Le besoin et le context de l'US doit être compris par tous et retranscrit dans la description
* Un maximum de 7 critères d'acceptances
* Les maquettes doivent être à jour et terminées avec un lien FIGMA
* Il faut anticiper les scénarios UX
* Les traductions doivent être présentes
* Les US doivent être découpées en tâches
* Un tech design validé
* Identifier les aspects de refontes
* Identifier le travail sur les tests
** Quel niveau pour les TI
** Quel niveau pour les tests end to end ( TNR & Front selenium )
* Fournir des jeux de tests et des exemples
* Les dépendances entre US doivent avoir été identifiées

== DOD : Definition Of Done ==

* DoD Développement
** Tous les critères d'acceptances sont implémentés
** Le Build est valide
** Test nominaux sur INT / BAC à sable / Local
** Alimenter le changelog
** Fournir des jeux de données supplémentaires
** Fournir la requête REST pour les tests d'API
** Review du code OK
* DoD Testing
** TU ( Java et/ou Angular )
** TI
** TNR
** End to End auto
* DoD Documentation
** Compléter le Tech Design
** [[Les RAML]]
** [[Documentation d'architecture (DAT)]]
** [[Documentation d'exploitation|Documentation d'exploitation (DEX)]]
** [[Documentation d'installation|Documentation d'installation (DIN)]]
** [[Documentation de migration|Documentation de migration (DMV)]] ( Script de montée de version ... )
** Le fichier README
** [[Mise à jour de l'ADR ( Log d'architecture )]]
** [[Listing des requêtes HTTP]]
** [[Documentation du workflow]]
** [[Documentation sur le modèle de données]]
* DoD Validation QA&UX
** Validation UX design
** Validation nominale
** Validation INT
** Validation ITREC
* DoD Validation PO
** Vérification documentaire
** Relecture finale

== Outils ==
Cette section recense les outils à disposition et leur usage dans le cadre du projet

== Jenkins ==

[https://jenkins.dev.programmevitam.fr/ Jenkins]

[https://jenkins.dev.programmevitam.fr/jenkins/job/doc-homepage/ws/index.html Tableau de Bord Vitam]

== Gestion des tickets ==

[https://assistance.programmevitam.fr/ Tuleap Bugtracker]

- Artefact USER STORIES est celui du projet

- Artefact DEMANDE PARTENAIRE est à suivre, recopier dans USER STORIES et à répondre aux partenaires

- Artefact Bugs = tickets de Bug de VITAM que notre recetteuse cherche à traiter avec l’Administration et l’équipe de dev.

== Contributions (Git) ==

[https://gitlab.dev.programmevitam.fr/vitam/vitam/merge_requests GitLab Vitam]

[https://github.com/ProgrammeVitam/vitam-ui/pulls Github Vitam UI]

Sert à suivre les états des MR. Une MR a le numéro du ticket Tuleap dans le titre (doit l'avoir en tout cas, sinon tu ne peux pas savoir si OK ou KO )

NB : Les accès sont gérés par les devOps

== Checkmarx ==
[https://checkmarx.preprod.programmevitam.fr/ Checkmarx]

Attention pour s’authentifier, choisir en option le : « VITAM OpenLdap »

== Sonar ==
[https://sonar.preprod.programmevitam.fr/dashboard?branch=develop&id=fr.gouv.vitam%3Aparent Tableau de bord (Preprod)]

== Squash ==
[https://squashtm.dev.programmevitam.fr/squash/login Tableau de bord Squash (multi projet)]