Articles /

WordPress.org

Die aktuellen Inline-Dokumentationsbemühungen von WordPress begannen wirklich im 3.7-Release-Zyklus und gewannen mit fortschreitender Hook-Docs-Initiative an Dynamik. Die Inline-Dokumentation oder “Inline Docs” -Initiative ist ein Hybridprojekt, das an den CoreCore-Kern berichtet und die Software enthält, die zum Ausführen von WordPress erforderlich ist. Das Kernentwicklungsteam erstellt WordPress., Dokumentation und Entwickler-Hub-Teams.

Was ist Inline-Dokumentation? #Was ist Inline-Dokumentation?

Die Inline-Dokumentation bietet sowohl notwendige als auch nützliche Informationen in Form von Inline-Kommentaren, Dokumentblöcken und mehr im Quellcode von WordPress selbst.

Die Inline-Dokumentation wird mit jeder Version analysiert, und diese Dokumentation wird in der Codereferenz unter developer.wordpress.orgWordPress.org Die Community-Site, auf der WordPress-Code erstellt und von den Benutzern geteilt wird. Hier können Sie den Quellcode für WordPress Core, Plugins und Themes sowie den zentralen Ort für Community-Gespräche und Organisation herunterladen. https://wordpress.org/.

Top

How to get involved #How to get involved

Inline–Dokumentation gilt als “technische” Dokumentation, daher ist eine gewisse Vertrautheit mit der WordPress-Codebasis erforderlich – Sie müssen den Code verstehen, um darüber schreiben zu können.

1. Machen Sie sich mit dem PHP-Dokumentationsstandard sowie den Formatierungsrichtlinien und Dokumentationstipps vertraut.

2. Richten Sie eine lokale Kopie der Entwicklerversion der WordPress-Codebasis mit variierenden Vagrant Vagrants (VVV) ein. WordPress versioniert mit SVNSVN Apache Subversion (oft abgekürzt SVN, nach seinem Befehlsnamen svn) ist ein Software-Versions- und Revisionskontrollsystem. Softwareentwickler verwenden Subversion, um aktuelle und historische Versionen von Dateien wie Quellcode, Webseiten und Dokumentation zu verwalten. Ziel ist es, ein weitgehend kompatibler Nachfolger des weit verbreiteten Concurrent Versions System (CVS) zu sein. WordPress Core und die wordpress.org freigegebener Code wird zentral über SVN verwaltet. https://subversion.apache.org/., aber Sie können auch GitGit verwenden Git ist ein kostenloses und Open Source verteiltes Versionskontrollsystem, das entwickelt wurde, um alles von kleinen bis sehr großen Projekten mit Geschwindigkeit und Effizienz zu bewältigen. Git ist einfach zu erlernen und hat eine winzige Stellfläche mit blitzschneller Leistung. Die meisten modernen Plugin-und Theme-Entwicklung wird mit diesem Versionskontrollsystem durchgeführt. https://git-scm.com/. (der VVV-Link, wie das geht).

3. Lesen Sie Ein Ticket öffnen, um zu erfahren, wie Sie einen TracTrac Trac ist der Ort, an dem Mitwirkende Probleme für Fehler oder Funktionsanforderungen erstellen, ähnlich wie bei GitHub.https://core.trac.wordpress.org/. Ticket.

4. Patches erstellen:

  • Aktualisieren Sie immer Ihre lokale Kopie von WordPress Trunk, bevor Sie die Datei bearbeiten und Patches erstellen. Verwenden Sie je nach Bedarf svn up oder git pull.
  • Generieren Sie den Patch aus dem Stammverzeichnis Ihres WordPress SVN- oder Git-Checkouts. Beispiel: svn diff dir/filename.php > function_name.diff.

5. Wie man einen Patch einreicht

Es gibt einen Patch, um die Inline-Dokumentationsfehler zu melden und
Zum Beispiel ist #48303 ein solcher Patch für WordPress 5.4.

  • Kommentar hinzufügen und Patchdatei anhängen.

6. Sie können auch zu Inline-Dokumenten-bezogenen Trac-Tickets beitragen, die iteriert werden müssen.

  • Wenn ein Ticket mit needs-patch oder needs-refresh gekennzeichnet ist, müssen die vorhandenen Patches möglicherweise nur nachgebessert oder mit dem neuesten Trunk aktualisiert werden. Jedes bisschen hilft!

Oben

Ansprechpartner #Ansprechpartner

Bei Fragen kannst du die Kanäle #docs oder #core-docs in Slack besuchen.

Oben

Ressourcen #Ressourcen

  • PHP-Dokumentationsstandard
  • Adam Browns Hooks-Datenbank (nützlich für Hinweise zu den @since -Versionen von hooksHooks In WordPress Theme und Entwicklung sind Hooks Funktionen, die auf eine Aktion oder einen Filter in WordPress angewendet werden können. Aktionen sind Funktionen, die ausgeführt werden, wenn ein bestimmtes Ereignis in WordPress auftritt. Mit Filtern können Sie bestimmte Funktionen ändern. Argumente, die zum Einbinden von Filtern und Aktionen verwendet werden, sehen gleich aus.)

Top

So öffnen Sie ein neues Dokumentticket #So öffnen Sie ein neues Dokumentticket

Grundsätzlich gibt es ein Ticket, um die Fehler und Verbesserungen der Inline-Dokumentation zu melden. Wenn Sie jedoch aus irgendeinem Grund ein neues Ticket erstellen müssen, führen Sie die folgenden Schritte aus:

  1. Lesen Sie Öffnen eines Tickets, um zu erfahren, wie Sie ein Trac-Ticket erstellen.
  2. Erstellen Sie ein neues Ticket für Core Trac für die Datei:
    • Vorgeschlagene Titelformate könnten “PHPDoc” für Pfad / zu / Datei sein.php” oder “Dokumentation für Pfad / zu/ Datei verbessern.PHP”.
    • Der Typ sollte defekt (bug) sein.
    • Weisen Sie das Ticket der Komponente zu, der die Datei zugeordnet ist.
    • Lassen Sie die Version leer.
    • Fügen Sie den Dokumentenfokus hinzu, indem Sie darauf klicken.
  3. Laden Sie Ihren Patch in das von Ihnen erstellte Trac-Ticket hoch und fügen Sie das Schlüsselwort has-patch hinzu.
  4. Hinterlasse einen Kommentar, der deinen neu hochgeladenen Patch beschreibt. Das einfache Hochladen von Patches löst keine Benachrichtigung für alle aus, die sich das Ticket ansehen.

Hinweis: Dokumentationsänderungen sollten nicht mit Codeänderungen (auch nicht mit Leerzeichen) vermischt werden, es sei denn, das Ticket fordert ausdrücklich beides.

Zuletzt aktualisiert: 26.Oktober 2019

Leave a Reply