Instructions pour une bonne developer experience

Ce document présente la procédure à suivre lors de la création et de la gestion des tickets de développement. Veuillez suivre chaque étape avec attention.

1. Création du Ticket

Titre du Ticket

Le titre doit décrire de manière générale la tâche à réaliser. Soyez précis, mais sans entrer dans les détails techniques. Par exemple :

Ajout d'une nouvelle fonctionnalité de recherche dans l'application

Correction du bug d'affichage sur la page d'accueil

Description du Ticket

La description doit fournir une explication légèrement détaillée des tâches à réaliser. Elle doit inclure les éléments suivants :

Objectif global de la tâche

Étapes spécifiques ou parties du projet concernées

Comportement attendu une fois la tâche accomplie

Assigner une personne au ticket

L'assignement d'une eprsonne est essentielle pour savoir qui travaille sur quoi. Si plusieurs personnes ont participé dans le ticket, vous pouvez le modifier.

Aller dans assignements ou assignees et choisissez les developers

Assigner une deadline (optionnel)

Le mieux serait d'ajouter une deadline pour les tâches pour savoir à peu près quand vous pensez avoir fini votre travail. ce n'est pas grave si vous n'en mettez pas mais si vous êtes sûr de quand vous allez à peu près le finir, cela peut-être intéressant de le savoir. C'est particulièrement intéressant pour les grosses tâches.

Note : vous pouvez créer des tickets pour d'autres personnes si vous avez des recommandations

2. Création de la Branche

Lorsque vous commencez à travailler sur un ticket, créez une nouvelle branche avec un nom particulier qui reflète le ticket en cours. Le format de la branche doit être :

nom-de-la-feature-#numeroduticket

Pour créer une branche :

git checkout -b feature-recherche-#123

3. Commit des Changements

Les commits doivent suivre la convention suivante :

• Le message de commit doit décrire brièvement le changement effectué.

• À la fin du message de commit, vous devez toujours ajouter le numéro du ticket pour faciliter le suivi des tâches.

Exemple de message de commit :

Ajout du champ de recherche sur la page d'accueil #123

4. Push de la Branche

Après avoir effectué vos changements et effectué vos commits, vous devrez pousser la branche sur le dépôt distant. Lors de votre premier git push, vous recevrez un message pour définir l'upstream de la branche.

Exemple de message affiché :

fatal: The upstream branch 'origin/feature-recherche-#123' does not exist
To push the branch and set the upstream, use the following command:
git push --set-upstream origin nom-de-la-feature-#numero 

Vous devez copier et coller la commande dans votre terminal pour effectuer le push. Une fois cette commande exécutée, votre branche sera poussée vers le dépôt distant.

5. Création d'une Pull Request (PR)

Une fois que vous avez poussé votre branche sur Gitea, vous devez ouvrir une pull request pour demander la révision de votre code.

Voici les étapes pour créer une pull request correctement :

• Allez sur Gitea et naviguez vers le projet concerné.

• Cliquez sur "Branches" et vous devriez voir la branche que vous venez de pousser.

• Cliquez sur le bouton "Create Pull Request" à côté de votre branche.

Remplissez les informations nécessaires :

• Titre de la PR : Utilisez le même titre que celui du ticket.

• Description de la PR : Décrivez brièvement ce que votre PR accomplit. Vous pouvez vous baser sur la description du ticket.

• Revues : Assurez-vous de demander une révision par deux membres de l’équipe.

• Cliquez sur "Create Pull Request" pour soumettre.

Une fois la PR ouverte, vous devrez attendre la révision et l’approbation de l’équipe avant de pouvoir fusionner la branche dans main ou develop selon le flux de travail de votre projet.

6. Après la fusion accordée

Une fois que la fusion de votre branche a été approuvée, vous devez supprimer cette branche localement. Pour se faire, recopiez cette commande :

git branch -d <nom_de_la_branche>

Lorsque vous avez supprimé votre branche et que vous souhaitez travailler à nouveau sur une nouvelle tâche, rebasez vous sur la branche master. Pour se faire suivez les instrucitons :

git checkout master 

Vérifiez que vous êtes bien sur la branche master :

git branch

Si vous êtes dessus, vous pouvez recommencer le rpocessus de création de ticket et de branche.

7. Révisions

Si vous voyez qu'une pull request est en attente, n'hésitez pas à jetter un coup d'oeil au code et à le TESTER également ! Si vous avez des doutes sur le code contactez l'un des participants pour plus de détails.

Si vous souhaitez réviser le code

Aller dans pull requests (ou demandes d'ajout) à côté des tickets (ou issues)

Vous y verrez les demandes d'ajouts en cours et déjà mergées. Si vous souhaitez faire une révision :

Cliquer sur celle qui vous intéresse et qui est open (ou ouverte)

Aller dans fichiers modifiés (ou files changed)

Vérifier et ajouter des commentaires si problèmes

Si problèmes refuser pull request et demander des changements

Si aucun problèmes en haut à droite cliquer sur évaluation (ou review)

Accepter les modifications et si vous êtes le deuxième à review, merger pull request

Note :

Une fois que tout ça est fait, supprimez la branche qui a été fusionnée, gitea le notifie juste après que vous ayez fusionner la branche dans l'historique de conversation de la pull request.

Résumé des Commandes Git :

Voici un récapitulatif des commandes Git que vous utiliserez fréquemment :

1. Créer une branche

git checkout -b feature-recherche-#123

2. Ajouter les fichiers modifiés :

git add .
git add *
git add <nom_du_fichier>

3. Commit des changements :

git commit -m "Ajout de [...] #numeroticket"

4. Pousser la branche

git push -set-upstream origin <nom-de-la-branche-#numeroticket>

5. Supprimer une branche

git branch -d <nom_de_la_branche>

6. Vérifier la branche où l'on se trouve

git branch

7. Changer de branche

git checkout <nom_de_la_branche>