Liste de contrôle pour le développement d'extensions PHP

Cet article présente la liste de contrôle de développement d'extensions PHP, qui a une certaine valeur de référence. Maintenant, je la partage avec vous. Les amis dans le besoin peuvent s'y référer

Pour réussir un package d'extension PHP, il ne suffit pas de mettre le code dans un dossier. De plus, de nombreux facteurs déterminent si votre extension est excellente. La liste de contrôle suivante vous aidera à peaufiner votre extension et à attirer davantage l'attention de la communauté PHP.

1. Choisissez un nom correct et approprié pour votre extension

• Assurez-vous que votre nom n'est pas utilisé par d'autres projets.

• Le nom de l'extension doit être cohérent avec votre espace de noms PHP.

• N'utilisez pas votre propre nom ou quoi que ce soit d'autre de personnel dans votre espace de noms.

2. Rendre votre extension open source

• GitHub peut gérer ce type de projet public gratuitement.

• GitHub vous est très utile pour gérer ce projet open source et permettre aux autres d'obtenir facilement vos extensions.

• Si vous ne souhaitez pas l'utiliser, vous pouvez essayer des alternatives : Bitbucket.

3. Soyez convivial avec le chargement automatique

• Utilisez l'espace de noms du chargeur automatique compatible PSR-4.

• Veuillez mettre le code dans le dossier

  . src

4. Publiez via Composer

• Assurez-vous que votre bibliothèque de classes peut être trouvée via Composer, qui est un outil de gestion des dépendances pour PHP

• Publié sur Packagist, un référentiel majeur de packages Composer.

5. Ne vous limitez pas aux frameworks

• Ne vous limitez pas aux projets qui ne peuvent être utilisés que sur un seul framework.

• Apporter un soutien particulier au framework via des prestataires de services.

6. Suivez un style de codage

• Il est fortement recommandé de vous en tenir au style de codage PSR-2.

• Utilisez des outils de formatage de code automatique, tels que PHP Coding Standards Fixer.

• Utilisez un outil de détection de style de code, tel que PHP Code Sniffer.

7. Écrivez des tests unitaires

• couvrent la majeure partie du code.

• Utilisez PHPUnit, un framework de tests unitaires PHP couramment utilisé.

• Autres options : phpspec, Behat, atoum, Codeception.

8. Écrivez des commentaires pour le code

• Traitez les commentaires comme une documentation intégrée.

• Les commentaires de code peuvent également améliorer la fonction d'auto-complétion de code des IDE, tels que PhpStorm.

• peut être automatiquement converti en documentation API, voir phpDocumentor.

9. Utiliser la gestion sémantique des versions

• Utiliser le numéro de version sémantique pour gérer le numéro de version.

• Suivez la spécification de version majeure version.minor version.patch.

• Permet aux développeurs de mettre à niveau les logiciels en toute sécurité sans se soucier des modifications interrompues.

• N'oubliez pas de marquer la version finale à temps !

10. Tenir un journal de mise à jour régulier

• Marquer et afficher clairement les modifications importantes entre les versions.

• Pensez à suivre le format Keep a CHANGELOG.

11. Utilisez l'intégration continue

• Utilisez les services pour vérifier automatiquement si le codage est standard et s'il peut réussir les tests en cours.

• Ce serait une bonne idée d'exécuter le test sur plusieurs versions PHP différentes.

• Assurez-vous qu'il peut s'exécuter automatiquement lors de la soumission ou de l'extraction.

• Référence : Travis-CI, Scrutinizer, Circle-CI.

12. Rédigez une documentation d'utilisation détaillée

• Une excellente documentation est cruciale pour un package d'extension.

• Assurez-vous au moins qu'il y a un fichier README détaillé dans la bibliothèque.

• Vous pouvez essayer d'héberger des documents dans les pages GitHub.

• Références disponibles : Lire la documentation.

13. Contient une licence

• Contient un accord de licence, qui peut protéger efficacement les résultats de votre travail, et très facile à faire.

• Référez-vous à Choosealicense.com. La plupart des projets open source PHP utilisent la licence MIT.

• Incluez au moins un fichier LICENSE dans la base de code.

• Pensez également à inclure votre contrat de licence dans Docblocks.

14. Les contributions de chacun sont les bienvenues

• Si vous souhaitez que tout le monde contribue à améliorer le projet, vous devez demander vos contributions !

• Il existe un fichier CONTRIBUTIF répertoriant la liste des contributeurs.

• Utilisez ce document pour expliquer les exigences en matière d'environnement de projet, telles qu'un environnement de test.

Pour des connaissances PHP plus modernes, veuillez vous rendre sur Laravel / PHP Knowledge Community

Recommandations associées :

PHP Résumé des tutoriels de développement d'extensions

Développement d'extensions PHP

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!