Introduction
GitHub fournit des outils de communication collaboratifs intégrés vous permettant d'interagir étroitement avec votre communauté. Ce guide de démarrage rapide vous montre comment choisir l’outil approprié à vos besoins.
Vous pouvez créer et participer à des questions, à des demandes de tirage ainsi qu’à des discussions d’équipe, selon le type de conversation que vous souhaitez engager.
GitHub Issues
- S’avèrent utiles pour discuter des détails spécifiques d’un projet, comme les rapports de bogues, les améliorations planifiées et les commentaires
- Sont propres à un dépôt et ont généralement un propriétaire clairement désigné
- Sont souvent désignés comme le système de suivi des bogues de GitHub
Demandes de tirage
- Vous permet de proposer des modifications spécifiques.
- Vous permettent de commenter directement les modifications proposées et suggérées par d’autres personnes
- Sont propres à un référentiel
Quel outil de discussion dois-je utiliser ?
Scénarios pour les problématiques
- Je veux garder une trace des tâches, améliorations et bogues.
- Je veux soumettre un rapport de bogue.
- Je veux partager des commentaires sur une fonctionnalité spécifique.
- Je veux poser une question sur des fichiers du dépôt.
Exemple de problème
Cet exemple montre comment un utilisateur GitHub a créé un problème dans notre référentiel de documentation open source pour nous informer d'un bogue et discuter d’un correctif.
- Un utilisateur a remarqué que la couleur bleue de la bannière située en haut de la page dans la version chinoise de GitHub Docs rend le texte qu’elle contient illisible.
- Cet utilisateur a créé un problème dans le dépôt, en le décrivant et en suggérant un correctif (à savoir, utiliser une autre couleur d’arrière-plan pour la bannière).
- Une discussion s’ensuit, pour finalement parvenir à un consensus sur le correctif à appliquer.
- Un contributeur peut alors créer une pull request avec le correctif.
Scénarios pour les pull requests
- Je veux corriger une faute de frappe dans un dépôt.
- Je veux apporter des modifications à un dépôt.
- Je veux apporter des modifications pour corriger un problème.
- Je veux commenter des modifications suggérées par d’autres personnes.
Exemple de pull request
Cet exemple montre comment un utilisateur de GitHub a créé un pull request dans notre référentiel open source de documentation pour corriger une faute de frappe.
Sous l’onglet Conversation de la pull request, l’auteur explique pourquoi il a créé la pull request.
L’onglet Fichiers modifiés de la pull request affiche le correctif implémenté.
- Ce contributeur remarque une faute de frappe dans le dépôt.
- L’utilisateur crée un pull request avec le correctif.
- Un mainteneur de dépôt passe en revue le pull request, y ajoute des commentaires, puis le fusionne.
Scénarios pour GitHub Discussions
- J’ai une question qui n’est pas nécessairement liée à des fichiers spécifiques du dépôt.
- Je veux diffuser des nouvelles à mes collaborateurs ou mon équipe.
- Je veux participer à une conversation ouverte ou en démarrer une.
- Je veux faire une annonce à ma communauté.
Exemple de discussion de produit GitHub Discussions
Cet exemple montre le billet d’accueil GitHub Discussions pour le dépôt GitHub Docs open source et illustre la façon dont l’équipe souhaite collaborer avec sa communauté.
Ce gestionnaire de la communauté a démarré une discussion pour accueillir la communauté et demander à ses membres de se présenter. Ce billet crée une atmosphère accueillante pour les visiteurs et les contributeurs. Le message clarifie également que l'équipe est heureuse de contribuer au répertoire.
Étapes suivantes
Ces exemples vous ont montré comment décider quel est le meilleur outil pour vos conversations sur GitHub. Mais ce n’est qu’un début ; il y a tant d’autres choses que vous pouvez faire pour adapter ces outils à vos besoins.
Pour les problèmes, par exemple, vous pouvez utiliser des étiquettes à des fins de recherche plus rapide et créer des modèles de problème pour aider les contributeurs à ouvrir des problèmes pertinents. Pour plus d’informations, consultez « À propos des problèmes » et « À propos des modèles de problème et de demande de tirage ».
Pour les demandes de tirage, vous pouvez créer des brouillons si les modifications que vous proposez sont encore en cours de travail. Les brouillons de pull requests ne peuvent pas être fusionnés tant qu’ils ne sont pas marqués comme prêts pour révision. Pour plus d’informations, consultez « À propos des demandes de tirage (pull requests) ».
Pour GitHub Discussions, vous pouvez épingler les discussions qui contiennent des informations importantes pour votre communauté. Pour plus d’informations, consultez « À propos des discussions ».
Pour découvrir certaines fonctionnalités de mise en forme avancées qui vous aideront à communiquer, consultez Démarrage rapide pour l’écriture sur GitHub.