Comment contribuer

React est l’un des premiers projets open source de Facebook qui est à la fois en développement intensif et utilisé en production sur les pages publiques de facebook.com. Nous travaillons encore à faire qu’il soit aussi facile et transparent que possible de contribuer à ce projet, et ce chantier n’est pas terminé. Mais avec un peu de chance, ce document éclaircira le processus de contribution et répondra à certaines des questions que vous pourriez avoir.

Code de conduite

Facebook a adopté le code de conduite Contributor Covenant et nous nous attendons à ce que les participant·e·s au projet y adhèrent. Veuillez lire le texte complet afin de comprendre quelles actions seront ou ne seront pas tolérées.

Développement ouvert

Tout travail sur React se passe directement sur GitHub. Les membres de l’équipe noyau (core team, NdT) tout comme les contributeurs externes y envoient leur pull requests, lesquelles passent à travers le même processus de revue.

Gestion sémantique des versions

React utilise une gestion sémantique de version. Nous publions des versions de correctifs pour les corrections de bugs critiques, des versions mineures pour les nouvelles fonctionnalités et les modifications non-essentielles, et des versions majeures s’il y a rupture de la compatibilité ascendante. Quand nous introduisons de telles ruptures, nous ajoutons aussi des avertissements de dépréciation dans une version mineure afin que nos utilisateur·rice·s puissent se familiariser avec les changements à venir et migrer leur code en amont. Vous pouvez en apprendre davantage sur notre engagement en termes de stabilité et de migration incrémentielle dans notre politique de gestion des versions.

Toute modification substancielle est documentée dans le journal des modifications.

Organisation des branches

Déposez toutes vos modifications directement sur la branche main. Nous n’utilisons pas de branches séparées pour le développement et pour les versions à venir. Nous faisons de notre mieux pour garder la branche main en bon état, avec des tests toujours au vert.

Le code qui atterrit dans main doit être compatible avec la dernière version stable. Il peut contenir de nouvelles fonctionnalités, mais pas de rupture de compatibilité ascendante. Nous devrions pouvoir sortir une version mineure à partir de la pointe de main à tout moment.

Fonctionnalités condtionnelles

Afin de conserver la branche main dans un état sortable, les ruptures de compatibilité ascendante et les fonctionnalités expérimentales doivent être protégées par un drapeau de fonctionnalité conditionnelle.

Ces drapeaux sont définis dans packages/shared/ReactFeatureFlags.js. D‘une version de React à l’autre, des jeux de fonctionnalités conditionnelles distincts sont susceptibles d’être utilisés ; par exemple, React Native peut être configuré différemment de React DOM. Ces variations sont signalées dans packages/shared/forks. Les drapeaux de fonctionnalités conditionnelles sont généralement typés par Flow, de sorte que vous pouvez exécuter yarn flow pour confirmer que vous avez mis à jour tous les fichiers nécessaires.

Le système de construction de React retirera toutes les branches fonctionnelles désactivées avant publication. Une routine d’intégration continue est exécutée à chaque commit pour auditer les évolutions de la taille du bundle. Vous pouvez utiliser ces changements de taille comme confirmation que votre fonctionnalité a bien été périmétrée.

Bugs

Où trouver les problèmes connus

Nous utilisons les GitHub Issues pour les bugs publics. Nous les surveillons attentivement et essayons d’être transparents sur le développement en cours d’un correctif interne. Avant de créer un nouveau ticket, essayez de vérifier que votre problème n’a pas déjà été signalé.

Signaler de nouveaux problèmes

Le meilleur moyen d’obtenir un correctif pour votre problème consiste à en fournir une reproduction minimale. Cet exemple JSFiddle est un excellent point de départ.

Problèmes de sécurité

Facebook a un programme de récompenses pour la communication sécurisée de problèmes de sécurité. En conséquence, merci de ne pas créer de ticket public pour ça : suivez le processus expliqué sur la page du programme.

Comment nous contacter

IRC : #reactjs sur freenode
Forums de discussion

Au cas où vous auriez besoin d’aide avec React, il existe aussi une communauté active d’utilisateurs de React sur la plate-forme de discussion Discord.

Proposer un changement

Si vous comptez proposer un changement de l’API publique ou faire un changement non trivial à l’implémentation, nous recommandons de créer un ticket. Ça nous permettra de nous mettre d’accord sur votre proposition avant que vous n’y investissiez un effort trop important.

Si vous corrigez seulement un bug, il est tout à fait acceptable d’envoyer directement une pull request, mais nous conseillons tout de même de créer d’abord un ticket détaillant ce que vous corrigez. C’est utile pour le cas où nous n’accepterions pas ce correctif spécifique mais souhaiterions garder une trace du problème.

Votre première pull request

Vous travaillez sur votre première pull request ? Vous pouvez apprendre comment faire ça au mieux grâce à cette série de vidéos gratuites (en anglais) :

Comment contribuer à un projet open source sur GitHub

Pour vous aider à vous jeter à l’eau et vous familiariser avec le processus de contribution, nous avons une liste de bons premiers tickets qui contient des bugs d’étendue relativement limitée. C’est un excellent point de départ.

Si vous décidez de corriger un bug, assurez-vous de vérifier le fil de commentaires au cas où quelqu’un serait déjà en train de travailler dessus. Si personne n’est dessus, veuillez laisser un commentaire indiquant que vous comptez vous y attaquer pour éviter que d’autres personnes ne dupliquent votre travail par accident.

Si quelqu’un dit travailler sur un correctif mais ne donne pas de nouvelle pendant deux semaines, vous pouvez prendre la relève, mais vous devriez tout de même laisser un commentaire dans ce sens.

Envoyer une pull request

L’équipe noyau surveille les pull requests. Nous ferons une revue de la vôtre et soit nous la fusionnerons, soit nous vous demanderons des ajustements, soit nous la fermerons en expliquant pourquoi. Pour les changements d’API, nous aurons peut-être besoin d’ajuster notre utilisation interne à facebook.com, ce qui pourrait retarder la fusion. Nous ferons cependant de notre mieux pour vous tenir informé·e tout au long du processus.

Avant d’envoyer une pull request, suivez attentivement ces instructions :

Forkez le dépôt et créez votre branche depuis main.
Lancez yarn à la racine du dépôt.
Si vous avez corrigé un bug ou ajouté du code qui devrait être testé, ajoutez les tests !
Assurez-vous que tous les tests passent (yarn test). Astuce : yarn test --watch NomDuTest est très utile en phase de développement.
Lancez yarn test-prod pour tester dans l’environnement de production. Cette commande accepte les même options que yarn test.
Si vous avez besoin d’un débogueur, lancez yarn debug-test --watch NomDuTest, ouvrez chrome://inspect, et appuyez sur « Inspecter ».
Formattez votre code avec prettier (yarn prettier).
Assurez-vous que votre code passe la vérification du linter (yarn lint). Astuce : yarn linc ne vérifiera que les fichiers qui ont changé.
Lancez les vérifications de types Flow (yarn flow).
Si vous ne l’avez pas encore fait, remplissez le CLA (voir ci-dessous).

Accord de licence de contribution (CLA)

Afin que nous puissions accepter votre pull request, nous avons besoin que vous remplissiez un CLA (Contributor License Agreement, NdT). Vous n’avez besoin de faire ça qu’une seule fois, donc si vous l’avez déjà fait pour un autre projet open source de Facebook, tout va bien. Si vous envoyez une pull request pour la première fois, dites-nous simplement que vous avez déjà rempli le CLA et nous pourrons le vérifier sur base de votre identifiant GitHub.

Remplissez votre CLA ici.

Pré-requis pour contribuer

Vous avez Node installé en v8.0.0+ et Yarn en v1.2.0+.
Vous avez le JDK installé.
Vous avez gcc installé ou êtes à l’aise avec le fait d’installer un compilateur si besoin. Certaines de nos dépendances peuvent nécessiter une étape de compilation. Sur OS X, les outils de ligne de commande XCode s’en occupent. Sur Ubuntu, apt-get install build-essential installera les paquets nécessaires. Des commandes similaires devraient fonctionner pour d’autres distributions Linux. Windows nécessite quelques étapes supplémentaires, consultez les instructions d’installation de node-gyp pour plus de détails.
Vous êtes à l’aise avec Git

Workflow de développement

Après avoir cloné votre fork de React, lancez yarn afin d’aller chercher les dépendances du projet. Ensuite, vous pouvez lancer différentes commandes :

yarn lint pour vérifier le style du code.
yarn linc fonctionne comme yarn lint mais va plus vite car elle ne vérifie que les fichiers qui ont changé sur votre branche.
yarn test lance la suite de tests complète.
yarn test --watch lance un superviseur interactif de tests.
yarn test <motif> lance les tests des fichiers dont le nom correspond au motif.
yarn test-prod lance les tests dans l’environnement de production. Elle accepte toutes les mêmes options que yarn test.
yarn debug-test fonctionne exactement comme yarn test mais avec un débogueur. Ouvrez chrome://inspect et appuyez sur « Inspecter ».
yarn flow lance les vérifications de types Flow.
yarn build crée un dossier build avec tous les modules.
yarn build react/index,react-dom/index --type=UMD crée des builds UMD seulement des modules indiqués, ici React et ReactDOM.

Nous recommandons d’utiliser yarn test (ou ses variations mentionnées ci-dessus) pour vous assurer de ne pas introduire de régressions en travaillant sur votre contribution. Cependant, il peut être pratique d’essayer votre build de React dans un vrai projet.

Tout d’abord, lancez yarn build. Ça produira des bundles pré-compilés dans le dossier build, et préparera les modules npm dans build/packages.

La manière la plus simple d’essayer vos modifications consiste à lancer yarn build react/index,react-dom/index --type=UMD et ensuite ouvrir fixtures/packaging/babel-standalone/dev.html. Ce fichier utilise déjà react.development.js depuis le dossier build, donc il utilisera vos évolutions.

Si vous voulez essayer vos évolutions dans votre projet React existant, vous pouvez copier build/node_modules/react/umd/react.development.js, build/node_modules/react-dom/umd/react-dom.development.js, ou tout autre produit de la compilation dans votre appli et les utiliser au lieu de la version stable.

Si votre projet utilise React via npm, vous pouvez supprimer react et react-dom dans ses dépendances et utiliser yarn link pour les faire pointer vers votre dossier local build. Remarquez qu’au lieu de --type=UMD vous voudrez plutôt passer --type=NODE à la construction. Vous aurez aussi besoin du module scheduler :

cd ~/chemin_vers_votre_clone_de_react/
yarn build react/index,react/jsx,react-dom/index,scheduler --type=NODE

cd build/node_modules/react
yarn link
cd build/node_modules/react-dom
yarn link

cd ~/chemin/vers/votre/projet
yarn link react react-dom

Chaque fois que vous lancez yarn build dans le dossier de React, les versions mises à jour apparaîtront dans le dossier node_modules de votre projet. Vous pouvez alors recompiler votre projet pour essayer vos modifications.

Si un module reste manquant (par ex. peut-être utilisez-vous react-dom/server dans votre projet), vous pouvez toujours faire une construction intégrale avec yarn build. Gardez à l’esprit que l’exécution de yarn build sans options prend beaucoup de temps.

Nous exigeons tout de même que votre pull request contienne des tests unitaires pour chaque nouvelle fonctionnalité. Ainsi nous pouvons nous assurer de ne pas casser votre code par la suite.

Guide de style

Nous utilisons un outil de formatage automatique appelé Prettier. Lancez yarn prettier après avoir changé le code.

Ensuite, notre linter repèrera la plupart des problèmes qui pourraient exister dans votre code. Vous pouvez vérifier l’état du style de votre code simplement en lançant yarn linc.

Cependant, il y a toujours certains styles que le linter ne peut pas remarquer. Si vous n’êtes pas sûr·e de votre coup, laissez-vous guider par le Guide de style de Airbnb.

Appels à commentaires (RFC)

Beaucoup de modifications, y compris les correctifs de bugs et les améliorations de la documentation, peuvent être implémentés et revus via le workflow normal de pull requests sur GitHub.

Certaines évolutions sont cependant plus « substantielles », et nous demandons à ce que celles-ci passent par une petite phase de conception afin d’obtenir un consensus au sein de l’équipe noyau de React.

Le processus de « RFC » (Request For Comments, NdT) a pour but de fournir un chemin contrôlé et cohérent pour l’introduction de nouvelles fonctionnalités dans le projet. Vous pouvez apporter votre contribution en consultant le dépôt des RFC.

Licence

En contribuant à React, vous acceptez que toute contribution que vous apportez soit licenciée sous la licence MIT.

Et maintenant ?

Lisez la page suivante pour apprendre comment la base de code est organisée.

Avez-vous trouvé cette page utile ?Modifier cette page