Contribution à l'open source: Gatekeeper Case Study

Contribuer au projet open source: un cas pratique

Cet article expliquera en détail comment contribuer le code aux projets open source à travers un cas pratique. Nous prendrons la bibliothèque Gatekeeper à titre d'exemple pour ajouter une fonction de comptage et démontrer progressivement l'intégralité du processus, y compris la communication avec le propriétaire du projet, la mise en œuvre du code, les tests et la soumission de la demande de traction.

Introduction à la bibliothèque Gatekeeper

Gatekeeper est une bibliothèque PHP pour l'enregistrement des utilisateurs, l'authentification et l'autorisation. Cela le rend complètement découplé à partir de l'application principale, ce qui facilite l'échelle et la modification.

Ajouter une fonction de comptage

À l'heure actuelle, pour obtenir le nombre total d'utilisateurs dans la base de données, Gatekeeper doit d'abord obtenir tous les enregistrements d'utilisateurs, puis compter ou écrire manuellement les requêtes SQL. Pour améliorer cela, nous ajouterons une fonction de comptage à l'interface de l'adaptateur pour le rendre natif et nous préparer à ajouter d'autres moteurs de base de données à l'avenir.

Étape 1: Communiquez avec le propriétaire du projet

Avant de commencer à contribuer, communiquez d'abord avec le propriétaire du projet pour confirmer si la fonctionnalité a été planifiée et si elle est nécessaire. Habituellement, il n'est possible que de le proposer dans la question du projet.

Étape 2: fourche, clone et test

Tout d'abord, Fork Project vers votre propre référentiel GitHub. Ensuite, le clone va localement, installez les dépendances et exécutez le test:

git clone <你的fork地址>
cd gatekeeper
composer install
vendor/bin/phpunit

Tous les tests doivent être passés. Après cela, créez une nouvelle branche à développer:

git checkout -b "feature-count"

Étape 3: Plan d'action

Gatekeeper ne prend actuellement en charge que les bases de données MySQL. Nous devons modifier la section suivante:

• Gatekeeper/DataSource: Résumé Classe de données de données
• DataSource/MySQL: source de données MySQL contenant des méthodes réelles
• DataSource/Stub: Mettez à jour le stub pour que les autres contributeurs sachent qu'ils doivent ajouter la méthode du nombre

Un nouveau processeur Count est également nécessaire, car Gatekeeper utilise des appels statiques magiques pour créer, trouver, mettre à jour et supprimer des entités.

Étape 4: implémentation du code

1. Déléguer l'appel statique: Ajouter un bloc Gatekeeper::__callStatic dans elseif déléguer l'appel statique au nouveau processeur Count. En même temps, mettez à jour les propriétés statiques $actions.

2. Créer un processeur Count: Créer Psecio/Gatekeeper/Handler/Count.php Fichier, écrivez la logique du processeur Count, qui est similaire au processeur Create, mais effectue une opération de comptage.

3. Modifier la source de données et le stub: Ajouter Psecio/Gatekeeper/DataSource/Stub.php Signature de la méthode dans count et les classes abstraites.

4. Implémentez la méthode de nombre de la source de données MySQL: Implémentez la méthode DataSource/MySQL.php dans count, qui utilise la fonction COUNT(*) de MySQL pour compter.

Étape 5: Tester

Créez un nouveau projet, installez la bibliothèque Gatekeeper modifiée à l'aide de Composer et effectuez des tests. Le test doit couvrir divers scénarios, tels que compter tous les utilisateurs, compter les utilisateurs en fonction des conditions, etc.

Étape 6: Soumettre la demande de traction

Soumettez le code à votre propre référentiel de fourche et créez une demande Pull pour soumettre des avis de code au propriétaire du projet.

Résumé

Cet article présente en détail le processus de contribution du code aux projets open source via un cas spécifique. Bien que ce cas soit relativement simple, il couvre la plupart des étapes qui contribuent à des projets open source et fournit une bonne référence aux développeurs qui souhaitent participer à des projets open source. N'oubliez pas que les tests et la communication claire sont essentiels aux contributions réussies.

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!