Guide de démarrage rapide pour les problèmes GitHub

Suivez ce petit guide interactif pour découvrir GitHub Issues.

Dans cet article

Introduction

Ce guide montre comment utiliser GitHub Issues pour planifier et suivre un élément de travail. Dans ce guide, vous allez créer un nouveau problème et le décomposer en sous-problèmes. Vous allez également apprendre à ajouter des étiquettes, des types de problèmes, des jalons, des personnes responsables et des projets pour communiquer des métadonnées sur votre problème.

Prérequis

Pour créer un problème, vous avez besoin d’un dépôt. Vous pouvez utiliser un dépôt existant auquel vous avez accès en écriture ou en créer un nouveau. Les problèmes doivent être activés sur le dépôt. Pour plus d’informations sur la création d’un référentiel, consultez Création d’un dépôt. Pour plus d’informations sur l’activation des problèmes s’ils sont désactivés dans votre référentiel, consultez Désactivation des problèmes.

Ouverture d’un problème vide

Pour commencer, créez un problème. Il existe plusieurs façons de créer un problème : vous pouvez choisir la méthode la plus pratique pour votre workflow. Cet exemple va utiliser l’interface utilisateur de GitHub. Pour plus d’informations sur les autres façons de créer un problème, consultez Création d’un problème.

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sous le nom de votre référentiel, cliquez sur Problèmes.

    Capture d’écran de la page principale d’un dépôt. Dans la barre de navigation horizontale, un onglet intitulé « Problèmes » est indiqué en orange foncé.

  3. Cliquez sur Nouveau problème.

  4. Dans cet exemple, nous allons commencer par un problème vide. Votre dépôt peut utiliser des modèles de problème pour encourager les contributeurs à fournir des informations spécifiques. Si votre dépôt utilise des modèles de problème, cliquez sur Ouvrir un problème vide.

Indication des informations

Donnez un titre descriptif à votre problème. Le titre doit refléter ce sur quoi porte le problème.

Ajoutez une description qui explique l’objectif du problème, y compris tous les détails susceptibles d’aider à le résoudre. Par exemple, s’il s’agit du signalement d’un bogue, décrivez les étapes à suivre pour reproduire le bogue, le résultat attendu et le résultat réel.

Vous pouvez utiliser Markdown pour ajouter une mise en forme, des liens, des emojis, etc. Pour plus d’informations, consultez « Écriture sur GitHub ».

Capture d’écran du formulaire d’un nouveau problème, avec un titre et un corps renseignés.

Ajout d’une liste de tâches

Vous pouvez également utiliser du texte brut pour suivre les tâches qui n’ont pas de problème correspondant et les convertir en problèmes ultérieurement. Pour plus d’informations, consultez « À propos des listes de tâches ».

Capture d’écran du formulaire d’un nouveau problème, avec le titre et le corps renseignés. Le corps inclut le Markdown d’une liste de tâches.

Affectation du problème

Pour transmettre la responsabilité, vous pouvez affecter le problème à un membre de votre organisation. Consultez Affectation de problèmes et demandes de tirage à d’autres utilisateurs GitHub.

Capture d’écran du formulaire d’un nouveau problème. Dans la barre latérale droite, la section « Destinataires » est encadrée en orange foncé.

Ajout d’étiquettes

Ajoutez une étiquette pour catégoriser votre problème. Par exemple, vous pouvez utiliser une étiquette question et une étiquette good first issue pour indiquer qu’un problème est une question qu’un contributeur novice pourrait traiter. Les utilisateurs peuvent filtrer les problèmes par étiquette pour rechercher tous les problèmes qui ont une étiquette spécifique.

Vous pouvez utiliser les étiquettes par défaut ou créer une étiquette. Pour plus d’informations, consultez «