Skip to main content

Configuration des modèles de problème pour votre dépôt

Vous pouvez personnaliser les modèles que les contributeurs peuvent utiliser pour ouvrir de nouveaux problèmes dans votre dépôt.

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 ».

Création de modèles de problème

  1. Dans votre instance GitHub Enterprise Server, accédez à la page principale du dépôt.

  2. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres. Capture d’écran d’un en-tête de dépôt montrant les onglets. L’onglet « Paramètres » est mis en évidence avec un encadré orange foncé.

  3. Dans la section « Fonctionnalités », sous Problèmes, cliquez sur Configurer des modèles. Vous devrez peut-être activer Problèmes et actualiser la page avant de pouvoir voir le bouton.

  4. Utilisez le menu déroulant Ajouter un modèle, puis cliquez sur le type de modèle à créer.

    Capture d’écran du menu déroulant « Ajouter un modèle » développé pour montrer les modèles standard « Rapport de bogue » et « Demande de fonctionnalité ». De plus, le « modèle personnalisé » est listé.

  5. Pour prévisualiser ou modifier le modèle avant de le commiter dans le dépôt, à côté du modèle, cliquez sur Prévisualiser et modifier.

  6. Pour modifier le modèle, cliquez sur , puis tapez dans les champs pour modifier leur contenu.

    Capture d’écran de l’aperçu d’un modèle de problème. À droite du nom du modèle, une icône de crayon est encadrée en orange foncé.

  7. Pour définir automatiquement un titre de problème par défaut, affecter le problème à des personnes disposant d’un accès en lecture au dépôt ou appliquer des étiquettes aux problèmes déclenchés du modèle, utilisez les champs sous « Informations supplémentaires facultatives ». Vous pouvez également ajouter ces détails dans le modèle de problème avec title, labels ou assignees dans un format d’informations préliminaires YAML.

  8. Une fois que vous avez fini de modifier et de prévisualiser votre modèle, cliquez sur Proposer des changements dans le coin supérieur droit de la page.

  9. Dans le champ « Message de commit », tapez un message de commit décrivant vos modifications.

  10. Sous les champs de message de commit, sélectionnez si vous souhaitez commiter votre modèle directement dans la branche par défaut, ou créer une branche et ouvrir une demande de tirage (pull request). Pour plus d’informations sur les demandes de tirage, consultez « À propos des demandes de tirage (pull requests) ».

  11. Cliquez sur Commiter les changements. Une fois ces changements fusionnés avec la branche par défaut, les contributeurs peuvent utiliser le modèle quand ils ouvrent de nouveaux problèmes dans le dépôt.

Configuration du sélecteur de modèles

Vous pouvez personnaliser le sélecteur de modèle de problème auquel les utilisateurs ont accès lorsqu’ils créent un problème dans votre référentiel en ajoutant un fichier config.yml au dossier .github/ISSUE_TEMPLATE.

Vous pouvez encourager les contributeurs à utiliser des modèles de problème en affectant la valeur false à blank_issues_enabled. Si vous affectez la valeur true à blank_issues_enabled, les utilisateurs peuvent ouvrir un problème vide, s’ils le souhaitent.

Remarque : Si vous avez utilisé le workflow hérité pour créer manuellement un fichier issue_template.md dans le dossier .github et activer les problèmes vides dans votre fichier config.yml, le modèle de issue_template.md sera utilisé quand les utilisateurs choisiront d’ouvrir un problème vide. Si vous désactivez les problèmes vides, le modèle ne sera jamais utilisé.

Si vous préférez recevoir certains rapports en dehors de GitHub Enterprise Server, vous pouvez diriger les utilisateurs vers des sites externes avec contact_links.

Voici un exemple de fichier config.yml.

YAML
blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.com/orgs/community/discussions
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

Votre fichier config personnalise le sélecteur de modèles quand le fichier est fusionné avec la branche par défaut du dépôt.

  1. Dans votre instance GitHub Enterprise Server, accédez à la page principale du dépôt.

  2. Au-dessus de la liste des fichiers, en utilisant la liste déroulante Ajouter un fichier, cliquez sur Créer un fichier.

  3. Dans le champ du nom de fichier, tapez .github/ISSUE_TEMPLATE/config.yml.

  4. Dans le corps du nouveau fichier, tapez le contenu de votre fichier config.

  5. 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 ».

  6. 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.

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

Pour aller plus loin