Share the post "Apprendre à contribuer au coeur de WordPress en 30min (tuto vidéo)"
Cette semaine, j’ai franchi une étape importante grâce à l’aide de Jean-Baptiste Audras et le soutien touchant de la communauté WordPress française.
C’est toujours un plaisir d’échanger avec l’équipe de Whodunit qui est top (merci à Eddy pour le montage et la mise en ligne de la vidéo issue de la visioconférence) !
Prérequis :
- Un ticket à patcher : https://core.trac.wordpress.org/ticket/49228
- Un compte sur w.org pour créer/commenter un ticket sur le Trac
- Un environnement de travail minimum qui comprend : un ordi avec internet, un éditeur de code, git et de quoi reproduire le bug et tester votre patch
- Cloner wordpress-develop sur github qui vous servira de base pour créer une nouvelle branche et pousser votre patch (https://github.com/WordPress/wordpress-develop)
J’étais sur ma machine perso sur laquelle je n’ai pas d’environnement de travail habituellement. Installer Git + un container avec un WordPress fonctionnel prend ~15 minutes. Évidemment, c’est variable en fonction de votre machine mais pour ce ticket en particulier pas besoin d’une installation complexe.
> Si vous préférez, la vidéo est en HD sur Youtube : https://youtu.be/7HNhX_BCHnY
Récapitulatif de la vidéo :
- 0:12 – Premier “du coup” de JB.
(Qui aime bien, charrie bien ! ?) - 0:16 – Première utilisation du mot “WordPress”.
- 0:28 – Ma première apparition (✌).
- 2:07 – Partage écran JB et présentation du ticket que l’on va patcher.
- 3:18 – Définition du good-first-bug :
Si vous souhaitez contribuer à WordPress mais que vous ne savez pas par quel ticket commencer, vous pouvez chercher ces tickets qui sont laissés pour les nouveaux contributeurs au cœur de WP. - 3:40 – Présentation du premier patch proposé sur le ticket pour expliquer la notion de fichier différentiel (.diff).
- 5:00 – Reproduction du bug :
Pour info, utilisez ctrl+shift+i pour ouvrir rapidement l’inspecteur de votre navigateur et ctrl+shift+m pour basculer sur la vue qui vous permet de changer d’appareil. - 07:37 – JB nous explique comment la résolution de bugs sur le cœur peut permettre de conseiller les développeurs tiers en rédigeant des devnotes à partir d’exemples de bonnes pratiques issues de tickets résolus.
- 8:30 – J’ai la parole, rappel à propos de mon profil et de mes compétences (spoiler : je ne suis pas dev et on peut tous contribuer).
- 8:43 – Partage de mon écran (?) : pour ceux que ça intéresse, j’utilise le terminal alternatif Cmder lorsque je suis sur Windows qui est très sympa.
- 9:57 – On reproduit le bug sur mon installation.
- 10:24 – On va tester le patch sur mon install : pour ça, on va chercher les deux fichiers qui concernent nos widgets situés dans \wp-includes\widgets\ et qui se nomment class-wp-widget-archives et class-wp-widget-categorie.
- 10:58 – On modifie le code des deux fichiers, on commence par celui du widget categorie pour tester le patch : au passage, ne faites pas comme moi : configurez votre éditeur pour qu’il gère les tabulations correctement lorsqu’il y a des retours à la ligne…
- 11:22 – On vérifie que le patch fonctionne correctement sur le widget categorie.
- 13:39 – On fait pareil pour le widget archives.
- 13:36 – On vérifie que le patch fonctionne également pour le widget archives.
- 16:08 – On passe sur git.
Pour info : à ce moment là j’avais déjà fait la manip suivante :
git clone https://github.com/WordPress/wordpress-developQui permet de cloner la branche master de WordPress et de récupérer cette branche dans un dossier local.
- 17:22 – On créé une nouvelle branche (49228-fix-checkbox) à partir de master dans laquelle on va ajouter notre patch.
- 18:54 – On change de branche.
- 19:40 – JB explique la différence entre la branche wordpress-develop et une installation standard de WordPress, notamment la présence de fichiers qui permettent de créer le paquet lors de la sortie d’une nouvelle version. Est-ce que la traduction des termes anglais utilisés par JB dans la vidéo comptent comme une contribution ? ?
- 21:13 – On ajoute notre patch sur notre nouvelle branche.
À ce moment, je me dis que ça aurait été une bonne idée de prendre wordress-develop comme base pour mon installation de contrôle afin de ne pas avoir à comparer les fichiers manuellement comme on a fait dans la vidéo. Pour quelques lignes de code en html ça va, mais y’a surement moyen de faire plus efficient pour des patchs plus importants et d’ajouter des contrôles. - 23:22 – On vérifie que les changements sont prêts.
- 23:38 – On ajoute les fichiers modifiés.
- 23:58 – On créé notre commit : JB expliquera plus loin dans la vidéo que le message du commit d’un patch n’est pas pris en compte par les core développeurs qui commits dans le cœur. Ce sont eux qui ajouteront un message final sur les changements effectués. Donc n’êtes pas obligé de vous prendre la tête pour le message de votre commit (même si c’est toujours une bonne pratique évidemment).
- 25:44 – On repasse sur le ticket.
Au passage, je vous conseille fortement d’adhérer à l’association WPFR (j’ai enfin pu le faire la semaine dernière) et de rejoindre le Slack communautaire qui est une mine d’or et un lieu d’échange super intéressant. - 26:12 – JB nous explique comment nommer nos fichiers .diff lorsqu’un patch a déjà été publié avant le notre.
- 27:00 – On créé notre fichier différentiel.
- 28:46 – On publie notre fichier 49228.1.diff sur le ticket.
- 30:34 – On n’oublie pas d’ajouter un commentaire pour expliquer notre patch afin de suivre les contributions plus facilement.
ET VOILÀ !
- 31:25 – Ouverture des questions/réponses jusqu’à la fin de la vidéo.
Petite liste de liens pratiques :
- Lien vers les résultats de recherche pour les good-first-bug sur le Trac.
- Lire les deux tutos de JB sur fr.w.org/news :
- la première partie,
- et voici la seconde partie, qui est à mon avis la plus intéressante car il aborde toute la partie technique.
Share the post "Apprendre à contribuer au coeur de WordPress en 30min (tuto vidéo)"