Définition de recommandations pour les contributeurs de dépôt

Vous pouvez créer des instructions pour expliquer comment les personnes doivent contribuer à votre projet.

Dans cet article

À propos des recommandations relatives aux contributions

Pour aider les contributeurs de votre projet à faire du bon travail, vous pouvez ajouter un fichier contenant des recommandations relatives aux contributions à la racine, au dossier docs ou au dossier .github du dépôt de votre projet. Quand une personne ouvre une demande de tirage ou crée un problème, elle voit un lien vers ce fichier.

Pour le propriétaire du dépôt, les recommandations relatives aux contributions sont un moyen de décrire la façon dont les utilisateurs doivent apporter leur contribution.

Pour les contributeurs, les recommandations sont un moyen de vérifier qu’ils envoient des demandes de tirage (pull request) bien formées, et qu’ils ouvrent des problèmes pertinents.

Pour les propriétaires comme pour les contributeurs, les recommandations relatives aux contributions permettent de gagner du temps et de réduire les tracas liés aux demandes de tirage mal créées, ou aux problèmes qui doivent être rejetés et soumis à nouveau.

Vous pouvez créer des instructions de contribution 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 ».

Tip

Les responsables de la gestion d’un référentiel peuvent définir des recommandations spécifiques aux problèmes en créant un modèle de problème ou de demande de tirage pour le référentiel. Pour plus d’informations, consultez « À propos des modèles de problème et de demande de tirage ».

Ajout d’un fichier CONTRIBUTING

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Au-dessus de la liste de fichiers, sélectionnez le menu déroulant Ajouter un fichier , puis cliquez sur Créer un 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. Déterminez si vous souhaitez stocker vos recommandations relatives aux contributions à la racine, dans le répertoire docs ou dans le répertoire .github de votre dépôt. Tapez ensuite dans le champ du nom de fichier, le nom et l’extension du fichier. Les noms de fichiers des recommandations relatives aux contributions ne respectent pas la casse. Les fichiers sont affichés au format RTF si l’extension de fichier est dans un format pris en charge. Pour plus d’informations, consultez « Travailler avec des fichiers non basés sur du code ».

    • Pour rendre vos recommandations relatives aux contributions visibles dans le répertoire racine du dépôt, tapez CONTRIBUTING.
    • Pour rendre vos recommandations relatives aux contributions visibles dans le répertoire docs du dépôt, tapez docs/ pour créer le répertoire, puis CONTRIBUTING.
    • Si un dépôt contient plusieurs fichiers CONTRIBUTING, le fichier affiché dans les liens est choisi parmi les emplacements suivants dans cet ordre : répertoire .github, puis répertoire racine du dépôt et enfin répertoire docs.

  4. Dans le nouveau fichier, ajoutez des recommandations relatives aux contributions. Vous pouvez inclure ce qui suit :

    • Étapes permettant de créer des problèmes ou des demandes de tirage utiles.
    • Liens vers de la documentation externe, des listes de diffusion ou un code de conduite.
    • Attentes liées à la communauté et au comportement.

  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.

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

Exemples de recommandations relatives aux contributions

Si vous êtes perplexe, voici quelques bons exemples de recommandations relatives aux contributions :

Pour aller plus loin