Diese zweiteilige Serie untersucht, wie man zum PHP-Projekt beitr?gt und sich auf Dokumentation in Teil 1 konzentriert. Wir decken Kontoanfragen und Nachabrechnungsschritte ab.

Schlüsselpunkte:

• Beitrag zur Dokumentation von PHP verbessert die Sprache und erh?ht Ihr PHP -Fachwissen. Es kann auch zu einem Php.NET -Konto führen, der die Richtung der Sprache beeinflusst.
• Die Dokumentation verwendet Docbook XML; Vertrautheit ist hilfreich, aber nicht obligatorisch.
• Anf?nger k?nnen den Online -Editor für einfache Patches verwenden. überprüfung der Richtlinien im Voraus sind ratsam.
• H?ufige Mitwirkende oder diejenigen, die umfangreiche ?nderungen ben?tigen, sollten die DOCs lokal einrichten und ein Php.net -Konto anfordern. Dies beinhaltet das Erstellen eines Verzeichnisses, das Klonen der Dokumente und das Konfigurieren von SVN -Schlüsselw?rtern.
• Beitr?ge umfassen Fehlerbehebungen, übersetzungen, Erweiterung vorhandener Inhalte, Dokumentation von undokumentierten Funktionen und allgemeine Verbesserungen.

Warum beitragen?

PHP, der Open-Source ist, lebt vom Engagement der Gemeinschaft. Die verst?rkte Teilnahme kommt allen zugute. Unabh?ngig davon, ob es sich um die Verbesserung der Dokumentation, das Beheben von Fehler oder das Hinzufügen von Funktionen, z?hlt jeder Beitrag. Aktive Teilnahme vertieft Ihr PHP -Wissen und erm?glicht es Ihnen, ein Php.net -Konto anzufordern, wobei die Zukunft der Sprache gestaltet wird.

PHP -Dokumentation

verstehen

Die Dokumentation befindet sich in Docbook XML. Vorwissen ist nicht ausschlie?lich notwendig; Die XML -Syntax ist leicht zu lernen.

Die Verzeichnisstruktur lautet:

doc-base enth?lt Tools zum Konvertieren der XML -Dokumentation. en h?lt die englische Dokumentation (andere Sprachen verwenden ihre Zwei-Buchstaben-Codes). reference enth?lt erweiterungsspezifische Verzeichnisse (Funktionen für prozedurale Erweiterungen, klassenbezeichnete Ordner für objektorientierte). Jeder Erweiterungsordner enth?lt book.xml (Zielseite) und versions.xml (Versioning -Info).

Die Dokumentation ist derzeit SVN-basiert (obwohl er zu Git migriert). Lokales Setup erfordert eine SVN -Vertrautheit.

Erstmalige Mitwirkende

Beginnen Sie mit dem Online -Dokumentationseditor. Dies erm?glicht die Anmeldung von OAuth und die Einreichung einfacher Patches. Konsistente Konto Verwendung vereinfacht die Verfolgung von Beitr?gen für zukünftige Php.net -Kontoanwendungen.

Machen Sie sich mit Style -Richtlinien vor, bevor Sie Patches einreichen.

Beispiel: Aufl?sen von Fehler #71716

Dieser Fehler meldet eine fehlerhafte MongoDB -Client -Klasse in einem Beispiel. Verwenden Sie nach der überprüfung den Online -Editor, um den Namespace zu korrigieren.

Video -Einbetten: http://m.miracleart.cn/link/14aa36297925d3c82891d74fa28d7df1 (ersetzen Sie es bei Bedarf durch den tats?chlichen Einbett -Code)

Lokales Setup

Der Online -Editor ist begrenzt; Richten Sie die DOCs lokal ein und fordern Sie ein php.net -Konto an.

.
1. phpdocs ein
Verzeichnis erstellen.
2. svn checkout https://svn.php.net/repository/phpdoc/modules/doc-en klonen Sie die Dokumente mit SVN:
3. git clone http://git.php.net/repository/phd.git Klon -PhD (Rendering -Tool):
4. git clone http://git.php.net/repository/web/php.git web-php klonen Sie die PHP.NET -Website: web-php/manual/en; Entfernen Sie
und erstellen Sie eine symbolische Verbindung zu den gerenderten Dokumenten.
5. ~/.subversion/config SVN -Schlüsselw?rter in *.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL:
6. konfigurieren ref (optional) Erstellen Sie eine
Datei mit Befehlen zur Validierung, Erstellung und Anzeige von Dokumenten lokal.

docs Workflow (lokal)

svn up Nach dem Einrichten aktualisieren Sie Repositories (git pull und php ~/phpdocs/doc-en/doc-base/configure.php). Bearbeiten Sie die entsprechende XML -Datei, validieren Sie mit svn ci -m "Resolve doc bug #..."), erstellen Sie mit PhD und starten Sie den lokalen Server. Bestimmungs?nderungen mithilfe von SVN (

, verweisen Sie auf die Fehlernummer. Schlie?en Sie den Fehlerbericht auf der Registerkarte "Entwickler" nach der Verbreitung von ?nderungen.

Anfordern eines php.net -Kontos

Fordern Sie nach lokalem Setup ein Php.NET -Konto bei DOCS Karma an. W?hrend keine strengen Voraussetzungen vorhanden sind, ist es wichtig, einen aktiven Beitrag zu demonstrieren. Senden Sie das Kontokontoanforderungsformular und senden Sie eine E -Mail an phpdoc@lists.php.net, um Ihre Absichten, Wiki -Benutzernamen und frühere Beitr?ge zu erl?utern.

Dokumentationsaufgaben

Beyond Fehlerbehebungen:

übersetzungen
teilweise dokumentiertes Material
• erweitern
• Dokumentieren von undokumentierten Funktionen

Allgemeine Verbesserungen

Allgemeine Tipps

• befolgen Sie die Stilrichtlinien.
• überprüfen Sie verwandte Aspekte bei der Behebung von Fehler.
• pr?zise schreiben.
• separates Beispielcode von Ausgabe.
• korrekte Seitenreihenfolge sicherstellen.
• PHP 4 Referenzen entfernen.
• ordnungsgem??e Version neue Dateien.

wenden Sie sich an die FAQ- oder PHP-Docs-Mailingliste der DOCs.

Schlussfolgerung

Dieser Teil umfasste zwei Workflows: Online -Editor und lokales Setup. Teil zwei wird abdecken, der zum Kern von PHP beitr?gt.

faqs (bewegt zum besseren Fluss)

• beitragen Prozess: Erstellen Sie ein Konto, bearbeiten/erstellen Inhalte, übersetzen Sie Richtlinien.
• Bedeutung des Beitrags: verbessert die Dokumentationsqualit?t, h?lt sie auf dem neuesten Stand, f?rdert die Community.
• Stellen Sie sicher
Nicht-Muttersprachler:
• Beitr?ge sind willkommen; übersetzung ist ein wertvoller Beitrag.
H?ufige Fehler:
• Nicht -Richtlinien, ungenaue/unklare Informationen, Mangel an Korrekturlesen, unn?tige ?nderungen.
Hilfe erhalten:
• Verwenden Sie Online -Foren, Diskussionsgruppen, Dokumentationsrichtlinien.
Anonymer Beitrag:
• m?glich, aber ein Konto wird gef?rdert.
Beitragsh?ufigkeit:
• variiert je nach Verfügbarkeit und Interesse.
Entsch?digung:
• Im Allgemeinen Freiwilligenarbeit.
Meldungsfehler:
• Korrigieren Sie sie, wenn ein Mitwirkender, ansonsten der Community Bericht erstattet.
Denken Sie daran, die Platzhalter -Bild -URLs durch die tats?chlichen Bild -URLs zu ersetzen. Ich habe die Bildformatierung bewahrt und die Bilder wie angefordert in ihren ursprünglichen Positionen aufbewahrt.

Das obige ist der detaillierte Inhalt vonBeitrag zu PHP: So tragen Sie zum Handbuch von PHP bei. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!