Documentation - Contributions à DS par des prestataires de l'Adullact (bonnes pratiques)

[dzc34]

Consignes pour les contributions faites par l'Adullact ou par des prestataires mandatés par l'Adullact.

Dépôts de code du logiciels DS

dépôt Github demarches-simplifiees/demarches-simplifiees.fr

• nommé dans le reste du document : "dépôt Github DINUM".
• les PR sont créées dans ce dépôt.

---

dépôt Github adullact/demarches-simplifiees.fr

• nommé dans le reste du document : "dépôt Github Adullact".
• à utiliser pour créer les branches qui serviront à créer les PR dans dépôt Github DINUM

Dépôt à utiliser pour créer les branches

Il est recommandé d'utiliser le dépôt Github adullact/demarches-simplifiees.fr pour ouvrir les PR, plutôt qu'un dépôt personnel comme speudoGithub/demarches-simplifiees.fr ; car l'équipe de la DINUM a les droits d'accès sur le dépôt de l'Adullact pour rebaser la PR avant de fusionner la contribution.

L'Adullact doit ajouter les développeurs du prestataire sur ce dépôt Github, avec les droits d'écritures pour leur permettre de créer les nouvelles branche qui serviront à ouvrir des PR.

Primo-développeurs

Pour les primo-développeurs du prestataire (nouveau sur le projet DS) :

• Accompagnement de l'Adullact à planifier sur les premières PR et premiers tickets.
• Dans un 1er temps, les PR sont publiées en mode draft, pour ne pas solliciter inutilement l'équipe de la DINUM.
• ... TODO à affiner

Création des branches et des PR

Les développeurs du prestataire, doivent :

• réaliser la mise à jour de la branche main du dépôt Github Adullact,
  dès que c'est nécessaire, à partir de la branche main du dépôt Github DINUM.
• pour les PR, créer les branches sur le dépôt Github Adullact à partir d'une branche main la plus à jour.
• ajouter les mots clés de suivi sur tous les tickets et toutes PR créés sur le dépôt Github DINUM.
• supprimer la branche utilisée par une PR, quand elle est fusionnée dans le code source du dépôt Github DINUM.

Dans une PR quand la branche n'est plus à jour :

• Ne pas faire de commit du type "Merge branch 'main' into feature/..." dans les PR.
• Plutôt faire un rebase de la branche sur la branche main à jour.
• Dans Github :
  • il ne faut pas utiliser directement le bouton "update branche" qui utiliser l'option par défault ("Update with merge commit")
  • TODO ---> vérifier si l'option "Update with rebase" fait bien le job

Autres conseils (TODO à affiner)

• ne pas faire trop de tickets et PR d'un coup, pour ne pas sur-sollicité l'équipe de la DINUM.
• une PR en mode draft peut-être intéressant dans certains cas :
  • primo-développeurs (nouveau sur le projet DS)
  • phase de recette de l'Adullact à planifier
  • ...

QA - Phase de recette

• les contributions, en particulier celles avec de UX/UI, passent par une phase de recette Adullact.
• les bug-fixes techniques (correctif d'un test, typo, ...) ne passent pas obligatoirement par une phase de recette.
• la recette Adullact peut être effectuée en fonction des contraintes techniques ou humaines :
  • via un serveur de recette du prestataire
  • via une VM (machine virtuelle) sur un ordinateur de l'Adullact

Documentation

Documentation de l'équipe DS pour les contributions :

• Bonnes pratiques de développement
• Coding conventions: early returns, ...