Collaborer avec Slack en tant que développeur Open Source

Introduction

Êtes-vous un développeur débutant qui cherche à acquérir plus d'expérience et vous vous demandez par où commencer ? Cet article de blog est fait pour vous !

L'une des meilleures façons de développer vos compétences est de contribuer à des projets open source. Récemment, j'ai résolu un problème dans le dépôt SlackAPI GitHub. Au moment de la rédaction, ma pull request (PR) a été acceptée par l'un des responsables, elle a passé toutes les builds CI et vient d'être fusionnée !?

Dans cet article, je partagerai mon parcours pour résoudre ce problème, les défis que j'ai rencontrés et les leçons que j'ai apprises en cours de route.

Problème

Le problème sur lequel j'ai travaillé concernait la gestion des URL dans l'API Slack. Plus précisément, le code n'ajoutait pas de barre oblique finale (/) à base_url si elle manquait, ce qui pouvait entraîner des appels d'API incohérents ou échoués.

Par exemple :

• Sans la barre oblique finale : https://slack.com/api
• Avec la barre oblique finale : https://slack.com/api/

La barre oblique manquante a provoqué des problèmes subtils qui ont dû être résolus pour garantir la fiabilité. Mon objectif était de modifier le code pour ajouter automatiquement la barre oblique si elle n'était pas fournie.

Vous pouvez trouver le numéro original ici : #1541.

Défis

Trouver les bons fichiers à modifier

En tant que débutant s'attaquant à une base de code volumineuse, mon premier défi a été de trouver où apporter les modifications. Naviguer dans des répertoires inconnus et comprendre la structure du projet a pris du temps. La lecture de la documentation et la lecture du code m'ont aidé à localiser les fichiers pertinents.

Écrire le correctif

Une fois que j'ai identifié le fichier (base_client.py), j'ai rédigé une solution pour m'assurer que base_url se termine par un /. Cependant, avant de l'implémenter, j'ai contacté les responsables pour obtenir des conseils. Ils ont souligné qu'une logique similaire devrait également être appliquée à deux autres fichiers : async_base_client.py et Legacy_base_client.py. Ce fut un excellent rappel de l'importance d'une communication claire et d'une discussion préalable dans les projets collaboratifs.

Voici l'extrait de code mis à jour pour ajouter la barre oblique finale :

if not base_url.endswith("/"):
    base_url += "/"

Ce simple changement garantissait que tous les appels d'API utiliseraient une URL de base cohérente. J'ai également répliqué cette logique dans les deux autres fichiers, en maintenant la cohérence entre les différents clients.

Ajout de tests

Les tests étaient une partie essentielle de ce correctif. J'ai ajouté de nouveaux tests dans le fichier test_web_client.py pour vérifier que le base_url a été corrigé s'il manquait la barre oblique finale. Par exemple :

• Entrée : http://localhost:8888
• Résultat attendu : http://localhost:8888/

Voici une version simplifiée de l'un des tests que j'ai ajouté :

if not base_url.endswith("/"):
    base_url += "/"

Points à retenir

Importance des tests

Avant de soumettre votre PR, testez minutieusement vos modifications. L'écriture de tests unitaires, l'exécution de tests existants et l'utilisation d'outils de débogage sont des étapes cruciales pour garantir que votre code fonctionne comme prévu. En automatisant les tests pour les cas extrêmes, vous pouvez détecter rapidement les erreurs potentielles et accroître la confiance dans votre solution.

Suivez les directives de contribution

Chaque projet open source a ses propres directives de contribution. Assurez-vous de les lire et de les suivre attentivement, car ils décrivent les normes de codage, les exigences de test et les processus de soumission des relations publiques. Par exemple, SlackAPI a fourni des instructions claires sur la configuration de l'environnement de développement et l'exécution de tests.

La communication est la clé

Discussion préalable de vos modifications avec les responsables peut vous faire gagner du temps et éviter des allers-retours inutiles. Dans mon cas, cela garantissait que j'appliquais le correctif à tous les fichiers pertinents, rendant la solution plus complète.
N'ayez pas peur de demander de l'aide

Si vous êtes bloqué, n’hésitez pas à poser des questions. Les mainteneurs et les contributeurs open source sont souvent solidaires et disposés à aider les nouveaux arrivants.

Pensées finales

Contribuer à l'open source peut sembler intimidant au début, mais c'est l'une des meilleures façons de grandir en tant que développeur. Vous apprendrez à travailler en équipe, à naviguer dans de grandes bases de code et à écrire du code prêt pour la production. De plus, c'est incroyable de voir votre travail être utilisé par d'autres !

Si vous êtes un développeur débutant, je vous encourage à explorer des projets open source, à trouver un problème qui vous intéresse et à franchir le pas. Le dépôt SlackAPI GitHub est un excellent point de départ !

Avez-vous contribué à un projet open source ? Partagez votre expérience dans les commentaires ci-dessous ! ?

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!