Ajouter un code de conduite à votre projet

Un code de conduite définit les standards d’engagement dans une communauté. Il établit un environnement inclusif qui respecte toutes les contributions. Il décrit également les procédures à suivre pour la résolution des problèmes entre les membres de la communauté de votre projet. Pour plus d’informations sur les raisons pour lesquelles un code de conduite définit des standards et des attentes concernant la manière de s’impliquer dans une communauté, consultez Open Source Guides.

Avant d’adopter un code de conduite pour votre projet :

• Recherchez différents codes de conduite conçus pour des projets open source. Choisissez-en un qui reflète les standards de votre communauté.
• Demandez-vous si vous êtes prêt à le faire respecter, et si vous en êtes capable.

Vous pouvez ajouter un code de conduite à votre projet en utilisant un modèle ou en créant manuellement un code de conduite personnalisé. Votre code de conduite est disponible dans tous les cas. Toutefois, le « Code de conduite » n’est marqué comme étant complet dans le profil de la communauté de votre dépôt que si vous utilisez un modèle. Si vous utilisez un code de conduite écrit par une autre personne ou organisation, veillez à suivre les recommandations d’attribution définies à la source. Pour plus d’informations sur les profils de la communauté, consultez À propos des profils de communauté des dépôts publics.

Vous pouvez créer un code de conduite 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 code de conduite à l’aide d’un modèle

GitHub fournit des modèles de code de conduite courants pour vous aider à ajouter rapidement un code de conduite à votre projet.

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.

   

3. Dans le champ du nom de fichier, tapez CODE_OF_CONDUCT.md.

4. Sélectionnez Choisir un modèle de code de conduite.

   

5. Dans la partie gauche de la page, sélectionnez un code de conduite pour en afficher l’aperçu et l’ajouter à votre projet.

6. Dans la partie droite de la page, renseignez les champs nécessaires pour fournir au code de conduite sélectionné les informations appropriées.

7. Cliquez sur Passer en revue et envoyer.

8. Passez en revue le contenu du code de conduite situé dans la zone de texte.

9. Cliquez sur Valider les modifications...

10. 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 ».

11. 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 ».

    

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

Ajout d’un code de conduite manuellement

Si le code de conduite à utiliser n’est pas disponible dans les modèles fournis, vous pouvez en ajouter un manuellement.

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.

   

3. Dans le champ du nom de fichier, tapez le nom et l’extension du fichier.

   • Pour rendre votre code de conduite visible dans le répertoire racine du dépôt, tapez CODE_OF_CONDUCT dans le champ du nom de fichier.
   • Pour rendre votre code de conduite visible dans le répertoire docs du dépôt, tapez docs/CODE_OF_CONDUCT.
   • Pour rendre votre code de conduite visible dans le répertoire .github du dépôt, tapez .github/CODE_OF_CONDUCT.

4. Dans le nouveau fichier, ajoutez votre code de conduite personnalisé.

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 ».

   

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