Skills à maîtriser

💙 Contributing Principles

<aside> 📘 Informations spécifiques sur les lignes directrices, les processus et les attentes pour les contributeurs potentiels souhaitant participer au développement du projet.

Le fichier 'CONTRIBUTING.md' décrit les étapes à suivre pour :

• soumettre des problèmes
• proposer des modifications
• fournir des rétroactions
• contribuer de manière générale au projet

afin de faciliter une collaboration efficace et cohérente entre les contributeurs et les mainteneurs du projet.

</aside>

Créer un fichier CONTRIBUTING.md

Wrangling Web Contributions: How to Build a CONTRIBUTING.md

Un fichier CONTRIBUTING.md, dans votre dépôt ou site open source, fournit aux contributeurs potentiels du projet un bref guide sur la façon dont ils peuvent contribuer à votre projet ou groupe d'étude. Il est d'usage de mettre le mot "contribution" en majuscule dans le titre du fichier et de l'enregistrer en tant que ressource en markdown (d'où l'extension .md).

🧍🏻Pour qui est ce fichier ?

• Les propriétaires du projet - les créateurs et les responsables du fichier
• Les contributeurs du projet - les utilisateurs du fichier qui souhaitent connaître les éléments qu'ils peuvent aborder et le tact dont ils ont besoin pour naviguer dans le projet/respecter les personnes impliquées dans le projet.
• Consommateurs du projet - utilisateurs qui souhaitent s'inspirer du projet pour créer leur propre projet.

<aside> 💎 CONTRIBUTING.md doit se trouver dans votre répertoire racine, considérez-le comme le point d'ancrage de votre projet, autour duquel vous construirez une communauté et garderez les choses en ordre. Il complète d'autres ressources "tout en majuscules" comme votre README.md (qui présente à votre communauté le projet, son but et les conditions d'installation de base), ou votre LICENSE.md (qui fournit des informations sur la réutilisation et les permissions associées au code).

</aside>

<aside> 💎 Le CONTRIBUTING.md doit être l'une de vos premières priorités lorsque vous mettez en ligne un projet open source/scientifique afin de solliciter des contributions. Si vous n'avez pas encore défini les voies possibles de contribution, envisagez de créer un fichier CONTRIBUTING.md avec un message "revenez plus tard, nous le remplirons bientôt", et les coordonnées du responsable du projet pour le suivi.

</aside>

<aside> 💎 Vous devriez essayer de créer une ébauche du fichier CONTRIBUTING.md avec les principaux contributeurs de votre projet afin de les aider à partager un sentiment de responsabilité et de créer le meilleur guide possible pour encourager les nouveaux contributeurs. Il est parfois préférable de s'entraîner à construire un fichier markdown dans un programme hors ligne comme Mou ou en ligne comme Dilliger avant de le mettre en ligne.

</aside>

Retrouve toutes les étapes à compléter.