Skip to main content

Création d’un modèle de demande de tirage pour votre dépôt

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.

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 PULL_REQUEST_TEMPLATE/ dans l’un des dossiers pris en charge pour y stocker plusieurs modèles de demande de tirage (pull request), puis utiliser le paramètre de requête template pour spécifier le modèle qui va remplir le corps de la demande de tirage. Pour plus d’informations, consultez « Utilisation de paramètres de requête pour créer une demande de tirage ».

Vous pouvez créer des modèles de demande de tirage par défaut 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 demande de tirage

  1. Dans , 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 :
    • Pour rendre votre modèle de demande de tirage visible dans le répertoire racine du dépôt, nommez le modèle de demande de tirage pull_request_template.md. Nom du nouveau modèle de demande de tirage dans le répertoire racine
    • Pour rendre votre modèle de demande de tirage visible dans le répertoire docs du dépôt, nommez le modèle de demande de tirage docs/pull_request_template.md. Nouveau modèle de demande de tirage dans le répertoire docs
    • Pour stocker votre fichier dans un répertoire masqué, nommez le modèle de demande de tirage .github/pull_request_template.md. Nouveau modèle de demande de tirage dans un répertoire masqué
    • Pour créer plusieurs modèles de demande de tirage et utiliser le paramètre de requête template afin de spécifier un modèle permettant de remplir le corps de la demande de tirage, tapez .github/PULL_REQUEST_TEMPLATE/ , puis le nom de votre modèle de demande de tirage. Par exemple : .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. Vous pouvez également stocker plusieurs modèles de demande de tirage (pull request) dans un sous-répertoire PULL_REQUEST_TEMPLATE au sein du répertoire racine ou du répertoire docs/. Pour plus d’informations, consultez « Utilisation de paramètres de requête pour créer une demande de tirage ». Nouveau modèle de demande de tirage multiple dans un répertoire masqué
  3. Dans le corps du nouveau fichier, ajoutez votre modèle de demande de tirage. Vous pouvez inclure ce qui suit :
  4. 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 Les modèles sont accessibles aux collaborateurs quand ils sont fusionnés avec la branche par défaut du dépôt.
  5. Cliquez sur Proposer un nouveau fichier. Bouton Proposer un nouveau fichier

Pour aller plus loin