Création manuelle d’un seul modèle de problème pour votre dépôt

Quand vous ajoutez un modèle de problème créé manuellement à votre dépôt, les contributeurs du projet voient automatiquement le contenu de ce modèle dans le corps du problème.

Dans cet article

Warning

Il s’agit du workflow hérité qui permet de créer un modèle de problème. Nous vous recommandons d’utiliser le générateur de modèles de problèmes multiples mis à jour ou les formulaires de problèmes pour créer des modèles de problèmes. Pour plus d’informations, consultez « À propos des modèles de problème et de demande de tirage ».

Vous pouvez créer un sous-répertoire ISSUE_TEMPLATE/ dans l’un des dossiers pris en charge pour y stocker plusieurs modèles de problème, puis utiliser le paramètre de requête template pour spécifier le modèle qui va remplir le corps du problème. Pour plus d’informations, consultez « Création d’un problème ».

Vous pouvez ajouter des informations préliminaires YAML à chaque modèle de problème pour préremplir le titre du problème, ajouter automatiquement des étiquettes et des personnes responsables, et attribuer au modèle un nom et une description qui s’afficheront dans le sélecteur de modèles à l’intention des utilisateurs qui créent un problème dans votre dépôt.

Voici un exemple d’informations préliminaires YAML.

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---

Note

Si une valeur présente dans les informations préliminaires comprend un caractère réservé YAML tel que :, vous devez placer la valeur entière entre guillemets. Par exemple, ":bug: Bug" ou ":new: triage needed, :bug: bug".

Pour être affichés avec une coche dans la check-list du profil de la communauté, les modèles de problème doivent se trouver dans le dossier .github/ISSUE_TEMPLATE et contenir des clés name: et about: valides dans les informations préliminaires (frontmatter) YAML (pour les modèles de problème définis dans des fichiers .md) ou des clés name: et description: valides (pour des formulaires de problème définis dans des fichiers .yml).

Vous pouvez créer des modèles de problème par défaut et un fichier de configuration par défaut des modèles de problème pour votre organisation ou votre compte personnel. Pour plus d’informations, consultez « Création d’un fichier d’intégrité de la communauté par défaut ».

Ajout d’un modèle de problème

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

  2. Au-dessus de la liste des fichiers, sélectionnez le menu déroulantAjouter un fichier puis cliquez sur Créer un nouveau fichier.

    Vous pouvez également cliquer sur dans l’arborescence de fichiers à gauche.

    Capture d’écran de la page principale d’un référentiel. Au-dessus de la liste des fichiers, un bouton, intitulé « Ajouter un fichier », est indiqué en orange foncé. Dans l’arborescence de fichiers du référentiel, un bouton, avec une icône du signe plus, est également encadré en orange foncé.

  3. Dans le champ du nom de fichier :

    • Pour rendre votre modèle de problème visible dans le répertoire racine du dépôt, tapez le nom de votre modèle_de_problème. Par exemple : issue_template.md.
    • Pour rendre votre modèle de problème visible dans le répertoire docs du dépôt, tapez docs/ suivi du nom de votre modèle_de_problème. Par exemple, docs/issue_template.md.
    • Pour stocker votre fichier dans un répertoire masqué, tapez .github/ suivi du nom de votre modèle_de_problème. Par exemple : .github/issue_template.md.
    • Pour créer plusieurs modèles de problème et utiliser le paramètre de requête template afin de spécifier un modèle permettant de remplir le corps du problème, tapez .github/ISSUE_TEMPLATE/ , puis le nom de votre modèle de problème. Par exemple : .github/ISSUE_TEMPLATE/issue_template.md. Vous pouvez également stocker plusieurs modèles de problème dans un sous-répertoire ISSUE_TEMPLATE au sein du répertoire racine ou du répertoire docs/. Pour plus d’informations, consultez « Création d’un problème ».

  4. Dans le corps du nouveau fichier, ajoutez votre modèle de problème. Vous pouvez inclure ce qui suit :

    • Informations préliminaires YAML
    • Comportement attendu et comportement réel
    • Les étapes pour reproduire le problème.
    • Spécifications telles que la version du projet, du système d’exploitation ou du matériel

  5. Cliquez sur Valider les modifications...

  6. Dans le champ de message de validation, tapez un message de validation court et descriptif qui indique la modification que vous avez apportée au fichier. Vous pouvez attribuer la validation à plusieurs auteurs dans le message de validation. Pour plus d’informations, consultez « Création d’une validation avec plusieurs auteurs ».

  7. Sous les champs de message de commit, choisissez si vous souhaitez ajouter votre commit à la branche actuelle ou à une nouvelle branche. Si votre branche actuelle est la branche par défaut, vous devez choisir de créer une branche pour votre validation, puis de créer une demande de tirage (pull request). Pour plus d’informations, consultez « Création d’une demande de tirage ».

    Capture d’écran d’une demande de tirage GitHub montrant une case d’option permettant de commiter directement dans la branche main ou de créer une branche. Une nouvelle branche est sélectionnée.
    Les modèles sont accessibles aux collaborateurs quand ils sont fusionnés avec la branche par défaut du dépôt.

  8. Cliquez sur Valider les modifications ou Proposer des modifications.

Pour aller plus loin