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.

Dans cet article

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 des paramètres de requête pour créer une demande de tirage ».

Vous pouvez créer des modèles de demande de tirage (pull request) 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. 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 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.
    • 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.
    • Pour stocker votre fichier dans un répertoire masqué, nommez le modèle de demande de tirage .github/pull_request_template.md.
    • 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 des paramètres de requête pour créer une demande de tirage ».

  4. Dans le corps du nouveau fichier, ajoutez votre modèle de demande de tirage. Ce modèle peut consister à demander à inclure :

  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