Étiquette pour les projets open source
Si vous n'avez jamais travaillé sur un projet open source (OSP pour « Open Source Project ») auparavant, il est bon de lire cet article avant de commencer à contribuer à MDN Web Docs et à d'autres projets open source. Il y a quelques comportements à adopter qui vous aident, vous et les autres contributeur·ice·s du projet, à vous sentir valorisés et en sécurité, et à rester productifs. Cet article ne vous apprend pas tout ce qu'il faut savoir sur la contribution à un projet open source ; l'objectif est de couvrir les sujets fondamentaux pour participer aux communautés open source.
Réfléchissez à la raison pour laquelle vous contribuez à un OSP
Avant de commencer à contribuer à un projet open source, demandez-vous pourquoi vous voulez le faire. Si la réponse à cette question est simplement « Je veux quelque chose à faire avec mon temps libre », c'est bien, mais des raisons encore meilleures pourraient être :
- Je veux améliorer mes compétences.
- J'utilise cet outil en permanence et j'ai trouvé un bogue dans celui-ci ou je veux contribuer à son amélioration.
- Je veux aider d'autres personnes à utiliser cet outil avec plus de succès.
- Je veux aider d'autres personnes à contribuer au projet avec plus de succès.
- Je veux démontrer publiquement mes propres compétences dans le cadre de mon cursus universitaire ou collégial ou pour améliorer mes chances de trouver un emploi.
Certaines de ces raisons sont égoïstes, et c'est bien ! Avoir un ensemble clair de raisons pour contribuer vous rend plus productif et facilite le travail avec la communauté.
Soyez polis, soyez aimables, évitez les propos incendiaires ou offensants
Nous pourrions résumer cela par « soyez aimables ». C'est notre principal conseil pour toute personne débutant dans les contributions open source. Soyez aimables avec les autres contributeur·ice·s du projet, et l'ambiance y sera plus agréable et plus productive.
- Remerciez les personnes si elles vous aident.
- Félicitez les personnes lorsque c'est approprié, par exemple si elles réussissent une demande de tirage ou corrigent un bogue difficile.
- Répondez toujours avec respect, même si vous pensez que la réponse à une question était évidente ou que quelqu'un a fait une erreur stupide.
Les contributeur·ice·s sont ici parce qu'ils veulent avoir un impact positif sur le projet. Au-delà de cela, ne faites pas d'hypothèses, telles que :
- Connaissance du projet et des technologies utilisées pour le construire
- Genre, sexualité, âge, langues parlées, lieu de résidence, opinions politiques, religion ou autres attributs personnels
- Expérience avec les projets open source
- Niveau de confiance
- Attentes
- Sens de l'humour
Vous devez rester sur le sujet et éviter les sujets controversés, tels que la religion ou la politique. Abstenez-vous de jurer ou d'utiliser un langage potentiellement offensant. Cela améliore rarement la communication et peut rendre plus difficile la participation des autres.
Faites preuve de soutien et de respect, même si vous n'êtes pas d'accord avec quelqu'un ou si vous n'appréciez pas une décision qu'il a prise.
Sachez que toute bonne communauté OSP dispose de règles visant à protéger ses contributeur·ice·s contre toute situation susceptible de les mettre mal à l'aise lors de leur participation.
Cela se trouve généralement dans un fichier CODE_OF_CONDUCT.md sur GitHub (voir mdn/content CODE_OF_CONDUCT (angl.) pour un exemple).
Les dépôts de MDN sont régis par les Directives relatives à la participation communautaire de Mozilla (DRP). En général, un comportement légèrement offensant sur les dépôts MDN Web Docs (comme être constamment hors sujet/perturbateur, ou être impoli) est d'abord signalé par un avertissement, suivi d'un avertissement final, puis d'une interdiction temporaire ou permanente. Les problèmes de comportement plus graves, tels que les discours de haine ou les menaces contre un·e autre contributeur·ice, ne sont pas tolérés et entraîneront probablement une sanction immédiate.
Si vous recevez quoi que ce soit qui vous met mal à l'aise, vous devez toujours le signaler en utilisant le mécanisme prévu dans le code de conduite.
Choisissez des contributions percutantes
Réfléchissez à ce que vous souhaitez faire dans le cadre de ce projet. Par exemple, nous disposons d'une longue liste de tickets enregistrés sur le tableau des tâches des contributeur·ice·s, classés par priorité de tâche. Vous pouvez également contribuer en ouvrant des demandes de tirage pour résoudre les problèmes que vous rencontrez en lisant les articles du site MDN.
Une grande partie du travail sur MDN consiste à rédiger de la documentation et des exemples de code, mais il existe d'autres façons de contribuer : Cela pourrait inclure aider à trier les problèmes qui arrivent, corriger des fautes de frappe, améliorer la grammaire pour rendre les pages plus compréhensibles, ou encadrer les personnes qui essaient de corriger les problèmes. Chaque correction est utile, aussi petite soit-elle, et nous n'en refusons aucune. Cela dit, veillez à ce que vos corrections soient productives. Nous vous déconseillons ce genre de contributions :
- Modifier le style du code, la formulation des textes ou le cadre de test simplement parce que vous le préférez ainsi.
- Remplacer l'anglais américain par l'anglais britannique dans les pages.
- Ajouter ou supprimer des signes de ponctuation alors que le texte original est correct.
Note : Pour les contenus traduits, nous vous recommandons de respecter le contenu écrit dans les pages anglaises, c'est ce contenu qui doit se retrouver dans la version traduite. De ce fait, si vous souhaitez changer le sens d'une phrase, ou ajouter un nouvel exemple ; il faut le faire en premier lieu sur la page anglaise avant de proposer une traduction.
Dans de nombreux cas, les choses sont ainsi sur les OSP pour une raison. Vous devriez lire les guides de style s'ils en ont un, et en cas de doute sur la productivité de quelque chose, demandez toujours d'abord !
Suivez le guide
Les bons OSP mettent toujours la documentation destinée aux contributeur·ice·s à la disposition de tous. Dans les projets GitHub, celle-ci se trouve généralement dans le fichier CONTRIBUTING.md du dépôt, ou parfois dans le fichier README.md du projet. En tant que projet de documentation, MDN dispose d'un fichier README (angl.) et d'un ensemble complet de documents destinés aux contributeur·ice·s sur le site même (voir Ressources communautaires).
N'hésitez pas à demander de l'aide, mais essayez toujours de trouver la réponse à votre question avant de la poser. De cette façon, vous enrichissez vos connaissances du projet et devenez plus autonome, sans imposer de charge inutile aux autres contributeur·ice·s. Si une explication est difficile à trouver ou n'est pas très bien décrite, ouvrez un ticket ou créez une pull request pour essayer de la corriger vous-même.
Découvrez où poser des questions
Découvrez où il est préférable de poser des questions. Les bons OSP le précisent toujours dans leur documentation (voir Contactez-nous). Si vous souhaitez poser des questions d'ordre général, utilisez toujours ces canaux. Ne déposez pas un ticket sur GitHub pour chaque question, car cela ajoute du bruit au projet (voir la section suivante).
Faites des progrès, pas du bruit
Réfléchissez bien à la manière dont vous gérez la communication au sein du projet — assurez-vous qu'elle soit utile et qu'elle ne complique pas la tâche des autres contributeur·ice·s. Soumettre des requêtes de tirage pour corriger des bogues, c'est très bien, mais veillez à ce qu'elles soient utiles ou faciles à examiner. Signaler des problèmes et participer à d'autres discussions est tout à fait acceptable, mais vos signalements et vos commentaires sont-ils pertinents, ou ne font-ils qu'ajouter du bruit ?
En règle générale, faites ceci :
- Discutez d'un sujet par problème — il est facile de garder les problèmes concentrés et productifs.
- Corrigez un problème par PR — cela peut représenter un peu plus de travail pour vous, mais il est beaucoup plus facile de revoir une seule correction claire.
- Contribuez à d'autres fils de discussion si vous avez un point utile à apporter ou si vous pouvez répondre à la question de quelqu'un d'autre.
- Posez des questions en utilisant d'autres mécanismes comme les salons de discussion ou les forums si vous n'êtes pas sûr de l'utilité de quelque chose ou si vous avez une question simple.
- Lisez le manuel d'abord pour essayer de répondre à la question vous-même avant de la poser.
Ne faites pas :
- Compliquer les problèmes en essayant de discuter de plusieurs sujets à la fois, ou en faisant des commentaires hors sujet.
- Essayer de regrouper plusieurs corrections dans une seule pull request. Cela rend la révision beaucoup plus difficile et suscite des soupçons (certaines personnes pourraient penser que vous essayez de cacher du code malveillant entre les modifications valides).
- Ouvrir de nombreux problèmes en posant des questions vagues.
- Poser des questions sans essayer de résoudre le problème par vous-même d'abord.
Les OSP sont une démocratie (ou presque)
Les OSP sont assez démocratiques — de nombreuses décisions font l'objet d'un vote, et vous êtes largement libre de contribuer comme vous le souhaitez, tant que vous n'empêchez personne d'autre de contribuer.
Cependant, certaines choses sont en grande partie décidées par un petit groupe de contributeur·ice·s principaux. Vous êtes libre de contester n'importe quelle décision, mais il arrive parfois qu'un·e modérateur·ice prenne une décision qui va à l'encontre de votre opinion. Vous devez respecter et accepter ces décisions.
Il est utile de faire connaissance avec les modérateur·ice·s de chaque projet, afin de savoir à qui vous adresser pour obtenir de l'aide, par exemple pour les requêtes de tirage ou les fils de discussion.
Soyez patient·e, soyez ponctuel·le
Gardez à l'esprit que de nombreuses personnes travaillant sur les OSP le font pendant leur temps libre, sans rémunération, et que toutes les personnes travaillant sur les OSP sont généralement très occupées. Si vous attendez une réponse, par exemple à une requête de tirage ou à une question, soyez patient.
Il est raisonnable d'attendre quelques jours, puis de relancer poliment la personne pour lui demander si elle a eu le temps d'y jeter un œil. Si elle est trop occupée, il vaut peut-être mieux attendre une semaine de plus et essayer de la relancer à ce moment-là.
Il n'est pas raisonnable ni poli d'exiger une réponse rapide.
Si quelqu'un attend que vous fassiez quelque chose pour lui, vous devriez lui accorder la même courtoisie, mais en même temps, essayez de répondre aussi rapidement que possible. Si vous ne pouvez vraiment pas trouver le temps, informez-les et demandez aux mainteneur·euse·s de vous aider à trouver quelqu'un d'autre pour accomplir la tâche.