Article original : How to Manage your Open Source Project with GitHub
La gestion de votre dépôt est l'une des tâches les plus importantes pour tout projet logiciel open source, individuel ou propriétaire.
Les dépôts de petits projets open source sont facilement maintenus sans utiliser de fonctionnalités supplémentaires, car peu de développeurs y travaillent.
Cependant, lors de la gestion de projets open source de taille moyenne ou grande, le problème principal réside dans la manière de les organiser.
Avec de nombreux développeurs contribuant en même temps et une communauté de développeurs s'étendant rapidement jour après jour, cela devient un défi significatif.
GitHub, GitLab, Gitea, etc., disposent de fonctionnalités similaires qui vous aident, vous et votre équipe, à gérer votre projet plus efficacement. Sans dépendre d'autres logiciels et outils, vous pouvez gérer votre projet directement avec votre dépôt.
Dans ce tutoriel, nous aborderons trois fonctionnalités de base de GitHub qui peuvent vous aider à gérer votre dépôt plus efficacement sans utiliser d'outils ou de services supplémentaires :
Labels
Projects
Milestones
GitHub, Gitlab ou Gitea ont tous des fonctionnalités similaires portant le même nom.
Comment utiliser les Labels sur GitHub
Le label aide à catégoriser les issues, les pull requests et les discussions. Par défaut, GitHub est livré avec quelques labels intégrés.
Vous pouvez également créer un label personnalisé. Vous pouvez utiliser le label sur n'importe quelle issue, pull request ou discussion au sein de votre dépôt.
Vous pouvez trouver la liste des labels par défaut dans la documentation GitHub.
Comment créer un Label dans votre dépôt
Créer un label personnalisé dans le dépôt est très simple. Il existe différentes façons de créer un label. Vous devez suivre ces étapes communes :
Allez dans votre dépôt > allez ensuite dans les issues > puis cliquez sur le bouton labels.
Ensuite, cliquez sur le bouton New Label et saisissez le nom, la description et la couleur de votre label.
Comment supprimer et modifier des Labels sur GitHub
Pour modifier et supprimer un label, allez sur la page des issues et cliquez sur le bouton Label. Sur la page des labels, vous devriez voir tous les labels existants.
Cliquez sur le bouton Edit pour modifier un label, et cliquez sur le bouton Delete pour supprimer un label.
Vous ne pouvez pas supprimer plusieurs labels à la fois avec GitHub.
Comment utiliser GitHub Projects
L'outil GitHub Projects est un outil polyvalent et flexible pour planifier et gérer le travail de votre dépôt dans un emplacement central.
Il fonctionne de manière similaire à une feuille de calcul, un tableau de tâches et une feuille de route, vous permettant de planifier et de suivre le travail de votre dépôt en un seul endroit. GitHub Projects est entièrement intégré à GitHub.
Vous pouvez créer et personnaliser plusieurs vues, filtrer, trier et grouper vos issues et pull requests, visualiser le travail avec des graphiques et ajouter des champs personnalisés pour suivre des métadonnées spécifiques.
Vous pouvez assigner des utilisateurs à des issues spécifiques, vérifier le statut des issues et assigner des réviseurs, entre autres fonctions.
Les GitHub Projects existent en deux types : publics et privés.
Les projets Publics sont visibles par tous, et l'équipe de gestion peut y apporter des modifications.
Les projets Privés, en revanche, ne sont pas visibles par les autres, et seule l'équipe de gestion peut les modifier.
Par défaut, les projets sont privés sur GitHub.
Comment créer des Projects sur GitHub
Créer un project est une tâche simple. Dans certains cas, l'onglet Projects peut ne pas être visible sur votre dépôt. Tout d'abord, allez dans les paramètres de votre dépôt et activez la fonctionnalité Project.
Après avoir activé les projects sur votre dépôt, vous devriez maintenant voir un onglet Projects. Cliquez sur cet onglet.
Votre page de projet par défaut ressemble à ceci. Pour créer un nouveau projet, cliquez sur l'icône de la liste déroulante et sélectionnez New Project, puis cliquez à nouveau sur l'option New Project.
Ensuite, sélectionnez le modèle pour le projet selon vos besoins. Cliquez sur le bouton view all pour voir tous les modèles disponibles, ou commencez avec un modèle vide.
Le modèle est livré avec une préconfiguration basée sur votre choix.
J'ai sélectionné le modèle « feature release » pour ce tutoriel. Ensuite, entrez le nom de votre projet et cliquez sur le bouton Create Project.
Votre projet devrait être créé sur la base du modèle choisi. La page de votre tableau de bord de projet peut varier selon le modèle.
Comment supprimer et modifier des Projects sur GitHub
Pour modifier et supprimer un projet, rendez-vous sur la page des projets.
Cliquez ensuite sur le projet que vous souhaitez modifier ou supprimer. Cliquer sur le titre du projet devrait vous mener à la page des paramètres du projet.
Dans la page des paramètres du projet, vous pouvez modifier le titre et la description du projet, supprimer le projet, fermer le projet et également changer la visibilité de votre projet de privé à public.
Comment utiliser les Milestones sur GitHub
La fonctionnalité Milestone vous permet de suivre la progression des issues ou des pull requests dans un dépôt. Avec les milestones, vous pouvez prioriser les issues et pull requests ouvertes et définir une date d'échéance pour un groupe d'éléments liés.
En termes simples, les milestones fonctionnent comme une liste de tâches, où vous pouvez détailler la quantité de travail terminé ou en attente. Cela fonctionne comme une barre de progression, aidant votre équipe à gérer le projet plus efficacement et à communiquer l'importance d'issues spécifiques à votre équipe ainsi qu'à la communauté open source.
Les milestones permettent à la communauté open source et à votre équipe de comprendre l'état d'avancement du travail et le calendrier des versions à venir.
Comment créer des Milestones sur GitHub
Tout d'abord, allez dans le dépôt puis sur la page des issues. Cliquez sur le bouton milestones.
Maintenant, vous devriez voir votre liste de milestones actuelle. Pour créer un milestone, cliquez sur le bouton new milestones.
Saisissez le titre du milestone, la date d'échéance et la description, puis cliquez sur le bouton Create milestones pour finaliser la création.
Par défaut, votre milestone créé devrait ressembler à ceci :
Notre tâche suivante consiste à assigner une issue au milestone. Allez dans l'issue concernée et assignez-lui un milestone.
Si vous avez plusieurs milestones, vous pouvez sélectionner celui de votre choix.
Vérifiez si l'issue est bien rattachée au milestone.
Désormais, vous pouvez attacher ou assigner plusieurs issues à un seul milestone. Lorsque vous consultez le milestone, vous pouvez voir la liste de toutes les issues assignées.
Si vous ou vos collaborateurs fermez l'issue, votre barre de progression augmente automatiquement. Cela aide votre équipe et votre communauté à visualiser la quantité de travail accomplie.
Comment supprimer et modifier des Milestones sur GitHub
Pour modifier et supprimer les milestones, rendez-vous sur la page des issues et cliquez sur le bouton milestones pour afficher les milestones disponibles.
Pour modifier un milestone, cliquez sur le bouton edit, et pour le supprimer, cliquez sur le bouton delete.
Conclusion
Les Labels, les Projects et les Milestones sont des fonctionnalités de base essentielles pour gérer un projet sur GitHub. En les utilisant, vous apprendrez naturellement à les maîtriser.
Les Milestones et les Projects sont différents, et ils ne sont pas directement comparables car ils offrent des fonctionnalités et des modes de fonctionnement distincts.
Comme je l'ai mentionné, un Milestone est utilisé pour suivre la progression des issues ou des pull requests dans un dépôt. D'un autre côté, un Project est utilisé pour planifier et gérer votre dépôt depuis un emplacement central.
Pour les petites équipes, je recommande les Milestones, et pour les grandes équipes, l'utilisation des Projects. Vous pouvez également combiner l'usage des Projects et des Milestones pour une meilleure productivité.
J'ai écrit d'autres articles liés à GitHub que vous pouvez consulter ici :