Skip to main content

À propos des modèles de problème et de demande de tirage

À l’aide des modèles de problèmes et de demandes de tirage, vous pouvez personnaliser et normaliser les informations que les contributeurs doivent inclure quand ils ouvrent des problèmes et des demandes de tirage dans votre dépôt.

Une fois que vous avez créé les modèles de problème et de demande de tirage (pull request) dans votre dépôt, les contributeurs peuvent utiliser ces modèles pour ouvrir des problèmes ou décrire les changements proposés dans leurs demandes de tirage en fonction des recommandations relatives aux contributions du dépôt. Pour plus d’informations sur l’ajout de recommandations relatives aux contributions à un dépôt, consultez « Définition de recommandations pour les contributeurs de dépôt ».

Modèles de problème

Quand vous créez des modèles de problème pour votre dépôt en utilisant le générateur de modèles de problème, les contributeurs peuvent sélectionner le modèle approprié au moment où ils ouvrent de nouveaux problèmes dans le dépôt.

Page de nouveau problème montrant les choix de modèle de problème

Les modèles de problème sont utiles quand vous souhaitez fournir des conseils d’aide sur l’ouverture de problèmes tout en permettant aux contributeurs de spécifier le contenu de leurs problèmes.

À l’aide du générateur de modèles, vous pouvez spécifier un titre et une description pour chaque modèle, ajouter le contenu du modèle, et commiter le modèle dans la branche par défaut ou ouvrir une demande de tirage dans le dépôt. Le générateur de modèles ajoute automatiquement les balises d’informations préliminaires YAML nécessaires pour que le modèle s’affiche dans la page de nouveau problème. Pour plus d’informations, consultez « Configuration des modèles de problème pour votre dépôt ».

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. Pour plus d’informations, consultez « Configuration des modèles de problème pour votre dépôt ».

Les modèles de problème sont stockés dans la branche par défaut du dépôt, dans un répertoire .github/ISSUE_TEMPLATE masqué. Si vous créez un modèle dans une autre branche, il ne pourra pas être utilisé par les collaborateurs. Les noms de fichiers des modèles de problème ne respectent pas la casse. Ils nécessitent l’extension .md. Pour être inclus 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 manuellement un seul modèle de problème en Markdown à l’aide du workflow hérité de modèle de problème. Les contributeurs du projet voient automatiquement le contenu du modèle dans le corps du problème. Toutefois, nous vous recommandons d’utiliser la mise à niveau du générateur de modèles de problème multiples pour créer des modèles de problème. Pour plus d’informations sur le workflow hérité, consultez « Création manuelle d’un seul modèle de problème pour votre dépôt ».

Vous pouvez créer une stratégie de sécurité afin de fournir aux utilisateurs des instructions pour signaler des vulnérabilités de sécurité dans votre projet. Pour plus d’informations, consultez « Ajout d’une stratégie de sécurité à votre dépôt ».

Modèles de demande de tirage

Quand vous ajoutez un modèle de demande de tirage (pull request) à votre dépôt, les contributeurs du projet voient automatiquement le contenu de ce modèle dans le corps de la demande de tirage.

Exemple de modèle de demande de tirage

Vous devez créer des modèles sur la branche par défaut du dépôt. Les modèles créés dans d’autres branches ne peuvent pas être utilisés par les collaborateurs. Vous pouvez stocker votre modèle de demande de tirage dans le répertoire racine visible du dépôt, le dossier docs ou le répertoire .github masqué. Les noms de fichiers de modèle de demande de tirage ne respectent pas la casse. Ils peuvent avoir l’extension .md ou .txt.

Pour plus d’informations, consultez « Création d’un modèle de demande de tirage pour votre dépôt ».