Guide complet pour mettre en place des templates GitHub

Les templates GitHub sont un outil puissant pour standardiser et accélérer vos processus de développement. Ils permettent de s’assurer que toutes les pull requests (PR) et les issues suivent un format cohérent, facilitant ainsi les revues de code et améliorant la productivité de l’équipe. Voici comment vous pouvez mettre en place des templates GitHub pour vos projets.

Pourquoi utiliser des templates GitHub ?

Standardisation
Les templates aident à standardiser les informations fournies dans les PR et les issues, ce qui facilite la compréhension et la revue par les autres membres de l’équipe.
Gain de temps
Avec un format prédéfini, les développeurs n’ont pas à réfléchir à la structure de leurs PR ou issues, ce qui accélère le processus de soumission.
Clarté
Les templates permettent de s’assurer que toutes les informations nécessaires sont incluses, réduisant ainsi les allers-retours pour obtenir des clarifications.

Comment créer un template de Pull Request

Créer un dossier .github à la racine de votre projet
À l’intérieur de ce dossier, créer un nouveau fichier pull_request_template.md
Une fois ce fichier créé, c’est un fichier markdown donc vous pouvez ajouter la nomenclature que vous souhaitez pour votre équipe.

Pour votre structure, il convient d’en discuter avec votre équipe afin de connaître les besoins récurrents, notamment sur les questions suivantes :

Quels sont vos réflexes lors de vos code review ?
Que regardez-vous lorsque vous faites de la review ?
Quelles sont les informations dont vous avez besoin pour bien review une PR ?
Quelles sont les “Definition of Done” de vos PR ?

Exprimez tout cela ensemble pour en faire une liste d’idées afin de choisir un bon template qui correspondra au mieux aux besoins de votre équipe.
N’oubliez pas que votre template peut être différent d’un projet à l’autre et peut être amélioré au fil du temps suivant le cycle de vie de vos projets et de votre équipe.

Étape 3 : Exemple de template

Le template qui suit est actuellement utilisé dans plusieurs de mes projets au sein de l’entreprise pour laquelle je travaille et a déjà fait ses preuves depuis sa mise en place.

Utilisez l’éditeur de texte pour écrire votre template.

# Informations

[TICKET-00000](https://jira.atlassian.net/browse/TICKET-00000)

---

## Dépendances avec

1. https://github.com/entreprise/projet/pull/486
2. https://github.com/entreprise/projet/pull/486
---

## 🧪 Comment tester ?

1. Aller à : [google.com](http://google.com)
2. ...
---

#### Screenshot:
![Expected Result](https://placehold.co/600x400?text=Insert+your+screenshot+here)

## 📋 Notes supplémentaires

À vos crayons ...

Rendu de notre exemple

Informations

TICKET-00000

Dépendances avec

🧪 Comment tester ?

Aller à : google.com
…

Screenshot:

Expected Result

📋 Notes supplémentaires

À vos crayons …

N’oubliez pas de modifier les informations et de les adapter à votre organisation. Dans ce template très simple, le développeur n’a plus qu’à :

Compléter le numéro de ticket JIRA
Indiquer si des dépendances avec d’autres PR sont nécessaires avant de passer celle-ci
Écrire le processus de test minimal
Ajouter des screenshots si nécessaire pour valider des rendus, ou montrer au développeur l’endroit de rendu
Écrire des notes supplémentaires si nécessaire

Bien sûr, le développeur est libre ou non de supprimer les rubriques non nécessaires à sa PR pour alléger la description de sa PR.

Étape 4 : Enregistrer le template

Une fois que vous avez terminé d’écrire votre template, envoyez le dossier .github dans votre projet et le template apparaîtra lors des prochaines pull requests de vos développeurs.

FAQ

Comment mettre à jour un template existant ?

Pour mettre à jour un template existant, modifiez simplement le fichier pull_request_template.md correspondant dans le dossier .github de votre dépôt.

Comment gérer les templates pour plusieurs dépôts ?

Créez un projet se nommant .github dans votre organisation pour vos templates et ajoutez le fichier pull_request_template.md. Votre template sera alors appliqué à tous vos dépôts GitHub.

Attention, votre projet .github devra être public, GitHub ne prenant pas en charge ce dépôt en privé.

Conclusion

Les templates GitHub sont un excellent moyen de standardiser et d’améliorer vos processus de développement. Vous pouvez facilement créer des templates pour les pull requests, ce qui aidera votre équipe à travailler de manière plus efficace et productive.