Skip to main content
Nous publions des mises à jour fréquentes de notre documentation, et la traduction de cette page peut encore être en cours. Pour obtenir les informations les plus actuelles, consultez la documentation anglaise.

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 GitHub.com, accédez à la page principale du dépôt. 1. Sous le nom de votre dépôt, cliquez sur Paramètres. Bouton Paramètres du dépôt
  2. Dans la section « Fonctionnalités », sous « Problèmes », cliquez sur Configurer des modèles. Bouton de démarrage de la configuration des modèles
  3. Utilisez le menu déroulant Ajouter un modèle, puis cliquez sur le type de modèle à créer. Menu déroulant Ajouter un modèle
  4. Pour prévisualiser ou modifier le modèle avant de le commiter dans le dépôt, cliquez sur Aperçu et modification. Bouton Aperçu et modification
  5. Pour modifier le modèle, cliquez sur , puis tapez dans les champs pour modifier leur contenu. Bouton de modification du modèle de problème
  6. 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 à votre modèle de problème, entrez ces détails 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. Informations supplémentaires sur le modèle de problème
  7. 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. Bouton Proposer des changements
  8. Entrez un message de commit décrivant vos changements. Champ de message de commit du modèle de problème
  9. Sous les champs de message de commit, choisissez 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 ». Modèle de problème permettant de choisir entre un commit vers la branche main ou l’ouverture d’une demande de tirage
  10. 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.

Création de formulaires de problème

Remarque : Les formulaires de problème sont actuellement en version bêta pour GitHub.com uniquement.

Avec les formulaires de problème, vous pouvez créer des modèles de problème ayant des champs de formulaire web personnalisables. Vous pouvez encourager les contributeurs à inclure des informations spécifiques et structurées à l’aide des formulaires de problème dans votre dépôt. Les formulaires de problème sont écrits en YAML à l’aide du schéma de formulaire GitHub. Pour plus d’informations, consultez « Syntaxe du schéma de formulaire de GitHub ». Si vous débutez avec YAML et souhaitez en savoir plus, consultez « Découvrir YAML en Y minutes ».

Pour utiliser un formulaire de problème dans votre dépôt, vous devez créer un fichier et l’ajouter au dossier .github/ISSUE_TEMPLATE de votre dépôt.

Voici un exemple de fichier config de formulaire de problème.

YAML
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
  - octocat
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Voici la version affichée du formulaire de problème. Formulaire de problème affiché

  1. Choisissez un dépôt dans lequel vous souhaitez créer un formulaire de problème. Vous pouvez utiliser un dépôt existant auquel vous avez accès en écriture, ou créer un dépôt. Pour plus d’informations sur la création d’un dépôt, consultez « Création d’un dépôt ».
  2. Dans votre dépôt, créez un fichier appelé .github/ISSUE_TEMPLATE/FORM-NAME.yml, en remplaçant FORM-NAME par le nom de votre formulaire de problème. Pour plus d’informations sur la création de fichiers sur GitHub, consultez « Création de fichiers ».
  3. Dans le corps du nouveau fichier, tapez le contenu de votre formulaire de problème. Pour plus d’informations, consultez « Syntaxe des formulaires de problème ».
  4. Commitez votre fichier dans la branche par défaut de votre dépôt. Pour plus d’informations, consultez « Création de fichiers ».

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, 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 GitHub.com, accédez à la page principale du dépôt. 1. Au-dessus de la liste des fichiers, en utilisant la liste déroulante Ajouter un fichier, cliquez sur Créer un fichier. « Créer un fichier » dans la liste déroulante « Ajouter un fichier »
  2. Dans le champ du nom de fichier, tapez .github/ISSUE_TEMPLATE/config.yml. Nom du fichier config
  3. Dans le corps du nouveau fichier, tapez le contenu de votre fichier config. Contenu du fichier config 1. En bas de la page, tapez un message de validation court et explicite décrivant 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 co-auteurs ». Message de validation pour votre modification 1. 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 ». Options de commit dans une branche 1. Cliquez sur Proposer un nouveau fichier. Bouton Proposer un nouveau fichier

Pour aller plus loin