Contribuer à PHP: comment contribuer au manuel de PHP
Cette série en deux parties explore comment contribuer au projet PHP, en se concentrant sur la documentation dans la première partie. Nous couvrirons les demandes de compte et les étapes post-approbation.
Points clés:
- La contribution à la documentation de PHP améliore la langue et stimule votre expertise PHP. Cela peut également conduire à un compte php.net, influençant la direction de la langue.
- La documentation utilise DocBook XML; La familiarité est utile mais pas obligatoire.
- Les débutants peuvent utiliser l'éditeur en ligne pour des correctifs simples. La révision des directives de style à l'avance est recommandée.
- Les contributeurs fréquents ou ceux qui ont besoin de modifications approfondies doivent configurer les documents localement et demander un compte php.net. Cela implique la création d'un répertoire, le clonage des documents et la configuration des mots clés SVN.
- Les contributions incluent les corrections de bogues, les traductions, l'expansion du contenu existant, la documentation des fonctionnalités sans papiers et les améliorations générales.
Pourquoi contribuer?
PHP, étant open-source, prospère sur la participation communautaire. Une participation accrue profite à tout le monde. Qu'il s'agisse d'améliorer la documentation, de corriger les bogues ou d'ajouter des fonctionnalités, chaque contribution compte. La participation active approfondit vos connaissances PHP et vous permet de demander un compte PHP.NET, en façonnant l'avenir de la langue.
Comprendre la documentation de PHP
La documentation est dans DocBook XML. Les connaissances antérieures ne sont pas strictement nécessaires; La syntaxe XML est facilement apprise.
La structure du répertoire est:
doc-base contient des outils pour convertir la documentation XML. en détient la documentation anglaise (d'autres langues utilisent leurs codes à deux lettres). reference contient des répertoires spécifiques à une extension (fonctions pour les extensions procédurales, les dossiers de classe pour ceux orientés objet). Chaque dossier d'extension comprend book.xml (page de destination) et versions.xml (Informations de versioning).
La documentation est actuellement basée sur SVN (bien que migrant vers GIT). La configuration locale nécessite une familiarité SVN.
Contributeurs pour la première fois
Commencez par utiliser l'éditeur de documentation en ligne. Cela permet la connexion et la soumission à OAuth de patchs simples. L'utilisation cohérente du compte simplifie les contributions de suivi pour les futures applications de compte php.net.
Familiarisez-vous avec les directives de style avant de soumettre des correctifs.
Exemple: Résolution du bug # 71716
Ce bogue rapporte une classe client MongoDB mal conforme à des noms de noms dans un échantillon. Après vérification, utilisez l'éditeur en ligne pour corriger l'espace de noms.
Embed vidéo: https://www.php.cn/link/14aa36297925d3c82891d74fa28d7df1 (Remplacez par du code emballé réel si nécessaire)
Configuration locale
L'éditeur en ligne est limité; Pour des contributions plus substantielles, configurez les documents localement et demandez un compte php.net.
- Créer un répertoire
phpdocs. - Clone les documents à l'aide de SVN:
svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en - Clone PhD (outil de rendu):
git clone http://git.php.net/repository/phd.git - Clone Le site Web PHP.NET:
git clone http://git.php.net/repository/web/php.git web-php; Supprimezweb-php/manual/enet créez un lien symbolique aux documents rendus. - Configurez les mots clés SVN dans
~/.subversion/config:*.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL - (facultatif) Créez un fichier
refavec des commandes de validation, de construction et de visualisation des documents localement.
Docs Workflow (local)
Après la configuration, mettez à jour les référentiels (svn up et git pull). Modifiez le fichier XML pertinent, validez à l'aide de php ~/phpdocs/doc-en/doc-base/configure.php, créez avec PhD et démarrez le serveur local. Engagez des modifications à l'aide de SVN (svn ci -m "Resolve doc bug #..."), faisant référence au numéro de bogue. Fermez le rapport de bogue de l'onglet "développeur" après les modifications Propagate.
demandant un compte php.net
Après la configuration locale, demandez un compte php.net avec Docs Karma. Bien qu'aucune condition préalable stricte n'existe, la démonstration de contribution active est essentielle. Soumettez le formulaire de demande de compte et envoyez un courriel à phpdoc@lists.php.net expliquant vos intentions, nom d'utilisateur Wiki et contributions passées.
Tâches de documentation
au-delà des corrections de bogues:
- Traductions
- élargir le matériel partiellement documenté
- documenter les fonctionnalités sans papiers
- Améliorations générales
Conseils généraux
- Suivre les directives de style.
- Vérifiez les aspects liés lors de la correction des bogues.
- Écrivez de manière concise.
- Exemple de code séparé de la sortie.
- Assurer la commande correcte de la page.
- supprimer les références php 4.
- version correctement de nouveaux fichiers.
- Consultez la liste de diffusion DOCS FAQ ou PHP-DOCS pour obtenir de l'aide.
Conclusion
Cette partie a couvert deux workflows: l'éditeur en ligne et la configuration locale. La deuxième partie couvrira la contribution au cœur de PHP.
faqs (déplacé à la fin pour un meilleur flux)
- Processus de contribution: Créer un compte, modifier / créer du contenu, traduire, suivre les directives.
- Importance de la contribution: Améliore la qualité de la documentation, le maintient à jour, favorise la communauté.
- Assurer l'acceptation: Suivez les directives, assurez-vous de l'exactitude et de la clarté, obtenez des commentaires.
- Les anglophones non natifs: Les contributions sont les bienvenues; La traduction est une contribution précieuse.
- Erreurs courantes: Ne pas suivre les directives, des informations inexactes / peu claires, le manque de relecture, les changements inutiles.
- Obtenir de l'aide: Utiliser des forums en ligne, des groupes de discussion, des directives de documentation.
- Contribution anonyme: possible, mais un compte est encouragé.
- Fréquence de contribution: varie en fonction de la disponibilité et de l'intérêt.
- Compensation: Généralement le travail de bénévolat.
- Erreurs de rapport: Corrigez-les si un contributeur, sinon signalez à la communauté.
N'oubliez pas de remplacer les URL de l'image d'espace réservé par les URL d'image réelles. J'ai conservé le formatage de l'image et gardé les images dans leurs positions d'origine comme demandé.
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!
Outils d'IA chauds
Undresser.AI Undress
Application basée sur l'IA pour créer des photos de nu réalistes
AI Clothes Remover
Outil d'IA en ligne pour supprimer les vêtements des photos.
Undress AI Tool
Images de déshabillage gratuites
Clothoff.io
Dissolvant de vêtements AI
Video Face Swap
Échangez les visages dans n'importe quelle vidéo sans effort grâce à notre outil d'échange de visage AI entièrement gratuit !
Article chaud
Outils chauds
Bloc-notes++7.3.1
Éditeur de code facile à utiliser et gratuit
SublimeText3 version chinoise
Version chinoise, très simple à utiliser
Envoyer Studio 13.0.1
Puissant environnement de développement intégré PHP
Dreamweaver CS6
Outils de développement Web visuel
SublimeText3 version Mac
Logiciel d'édition de code au niveau de Dieu (SublimeText3)
Sujets chauds
Expliquez les jetons Web JSON (JWT) et leur cas d'utilisation dans les API PHP.
Apr 05, 2025 am 12:04 AM
JWT est une norme ouverte basée sur JSON, utilisée pour transmettre en toute sécurité des informations entre les parties, principalement pour l'authentification de l'identité et l'échange d'informations. 1. JWT se compose de trois parties: en-tête, charge utile et signature. 2. Le principe de travail de JWT comprend trois étapes: la génération de JWT, la vérification de la charge utile JWT et l'analyse. 3. Lorsque vous utilisez JWT pour l'authentification en PHP, JWT peut être généré et vérifié, et les informations sur le rôle et l'autorisation des utilisateurs peuvent être incluses dans l'utilisation avancée. 4. Les erreurs courantes incluent une défaillance de vérification de signature, l'expiration des jetons et la charge utile surdimensionnée. Les compétences de débogage incluent l'utilisation des outils de débogage et de l'exploitation forestière. 5. L'optimisation des performances et les meilleures pratiques incluent l'utilisation des algorithmes de signature appropriés, la définition des périodes de validité raisonnablement,
Comment fonctionne le détournement de session et comment pouvez-vous l'atténuer en PHP?
Apr 06, 2025 am 12:02 AM
Le détournement de la session peut être réalisé via les étapes suivantes: 1. Obtenez l'ID de session, 2. Utilisez l'ID de session, 3. Gardez la session active. Les méthodes pour empêcher le détournement de la session en PHP incluent: 1. Utilisez la fonction Session_RegeReate_id () pour régénérer l'ID de session, 2. Stocker les données de session via la base de données, 3. Assurez-vous que toutes les données de session sont transmises via HTTPS.
Que sont les énumérations (enums) dans PHP 8.1?
Apr 03, 2025 am 12:05 AM
La fonction d'énumération dans PHP8.1 améliore la clarté et la sécurité du type du code en définissant les constantes nommées. 1) Les énumérations peuvent être des entiers, des chaînes ou des objets, améliorant la lisibilité du code et la sécurité des types. 2) L'énumération est basée sur la classe et prend en charge des fonctionnalités orientées objet telles que la traversée et la réflexion. 3) L'énumération peut être utilisée pour la comparaison et l'attribution pour assurer la sécurité du type. 4) L'énumération prend en charge l'ajout de méthodes pour implémenter une logique complexe. 5) La vérification stricte et la gestion des erreurs peuvent éviter les erreurs courantes. 6) L'énumération réduit la valeur magique et améliore la maintenabilité, mais prêtez attention à l'optimisation des performances.
Décrivez les principes solides et comment ils s'appliquent au développement de PHP.
Apr 03, 2025 am 12:04 AM
L'application du principe solide dans le développement de PHP comprend: 1. Principe de responsabilité unique (SRP): Chaque classe n'est responsable d'une seule fonction. 2. Principe ouvert et ferme (OCP): les changements sont réalisés par extension plutôt que par modification. 3. Principe de substitution de Lisch (LSP): les sous-classes peuvent remplacer les classes de base sans affecter la précision du programme. 4. Principe d'isolement d'interface (ISP): utilisez des interfaces à grain fin pour éviter les dépendances et les méthodes inutilisées. 5. Principe d'inversion de dépendance (DIP): les modules élevés et de bas niveau reposent sur l'abstraction et sont mis en œuvre par injection de dépendance.
Expliquez la liaison statique tardive en PHP (statique: :).
Apr 03, 2025 am 12:04 AM
Liaison statique (statique: :) implémente la liaison statique tardive (LSB) dans PHP, permettant à des classes d'appel d'être référencées dans des contextes statiques plutôt que de définir des classes. 1) Le processus d'analyse est effectué au moment de l'exécution, 2) Recherchez la classe d'appel dans la relation de succession, 3) il peut apporter des frais généraux de performance.
Qu'est-ce que les principes de conception de l'API REST?
Apr 04, 2025 am 12:01 AM
Les principes de conception de Restapi incluent la définition des ressources, la conception URI, l'utilisation de la méthode HTTP, l'utilisation du code d'état, le contrôle de version et les haineux. 1. Les ressources doivent être représentées par des noms et maintenues dans une hiérarchie. 2. Les méthodes HTTP devraient être conformes à leur sémantique, telles que GET est utilisée pour obtenir des ressources. 3. Le code d'état doit être utilisé correctement, tel que 404 signifie que la ressource n'existe pas. 4. Le contrôle de la version peut être implémenté via URI ou en-tête. 5. Hateoas bottise les opérations du client via des liens en réponse.
Comment gérez-vous efficacement les exceptions en PHP (essayez, attrapez, enfin, jetez)?
Apr 05, 2025 am 12:03 AM
En PHP, la gestion des exceptions est réalisée grâce aux mots clés d'essai, de catch, enfin et de lancement. 1) Le bloc d'essai entoure le code qui peut lancer des exceptions; 2) Le bloc de capture gère les exceptions; 3) Enfin, Block garantit que le code est toujours exécuté; 4) Le lancer est utilisé pour lancer manuellement les exceptions. Ces mécanismes aident à améliorer la robustesse et la maintenabilité de votre code.
Quelles sont les classes anonymes en PHP et quand pouvez-vous les utiliser?
Apr 04, 2025 am 12:02 AM
La fonction principale des classes anonymes en PHP est de créer des objets uniques. 1. Les classes anonymes permettent aux classes sans nom d'être définies directement dans le code, ce qui convient aux exigences temporaires. 2. Ils peuvent hériter des classes ou implémenter des interfaces pour augmenter la flexibilité. 3. Faites attention aux performances et à la lisibilité au code lorsque vous l'utilisez et évitez de définir à plusieurs reprises les mêmes classes anonymes.
