Articles /

WordPress.org

současné úsilí o inline dokumentaci WordPress skutečně začalo v cyklu vydání 3.7 a nabralo na síle, jak postupovala iniciativa hook docs. Inline dokumentace nebo iniciativa” inline docs ” je hybridní projekt, hlášení jádru CoreCore je sada softwaru potřebného ke spuštění WordPress. Hlavní vývojový tým staví WordPress., Dokumentace, a vývojářský Hub týmy.

co je inline dokumentace? #Co je inline dokumentace?

Inline dokumentace poskytuje potřebné i užitečné informace ve formě inline komentářů, bloků doc a dalších ve zdrojovém kódu samotného WordPress.

inline dokumentace je analyzována s každým vydáním a tato dokumentace je zobrazena v kódu reference na developer.wordpress.orgWordPress.org komunitní web, kde je Kód WordPress vytvořen a sdílen uživateli. Zde si můžete stáhnout zdrojový kód pro jádro WordPress, pluginy a témata, stejně jako centrální umístění komunitních konverzací a organizace. https://wordpress.org/.

Top

jak se zapojit #jak se zapojit

Inline dokumentace je považována za “technickou” dokumentaci, takže bude nutná určitá znalost kódové základny WordPress – musíte pochopit kód, abyste o ní mohli psát.

1. Seznamte se se standardem dokumentace PHP, pokyny pro formátování a tipy pro dokumentaci.

2. Nastavte místní kopii vývojářské verze kódové základny WordPress pomocí Variing Vagrant Vagrants (VVV). WordPress je verzování pomocí SVNSVN Apache Subversion (často zkráceně SVN, po názvu příkazu svn) je software pro verzování a kontrolu revizí. Vývojáři softwaru používají Subversion k udržování aktuálních a historických verzí souborů, jako je zdrojový kód, webové stránky a dokumentace. Jeho cílem je být většinou kompatibilním nástupcem široce používaného systému souběžných verzí (CVS). WordPress jádro a wordpress.org uvolněný kód je centrálně spravován prostřednictvím SVN. https://subversion.apache.org/., ale můžete také použít GitGit Git je bezplatný a open source distribuovaný systém pro správu verzí navržený tak, aby zvládl vše od malých až po velmi velké projekty s rychlostí a efektivitou. Git se snadno učí a má malou stopu s bleskem rychlým výkonem. Nejmodernější plugin a téma Vývoj se provádí s tímto systémem pro správu verzí. https://git-scm.com/. (odkaz VVV na to, jak to udělat).

3. Přečtěte si otevření tiketu a naučte se, jak vytvořit TracTrac Trac, je místo, kde přispěvatelé vytvářejí problémy s chybami nebo požadavky na nové funkce, podobně jako GitHub.https://core.trac.wordpress.org/. vstupenka.

4. Vytváření záplat:

  • před úpravou souboru a vytvořením oprav vždy aktualizujte místní kopii kmene WordPress. Podle potřeby použijte svn up nebo git pull.
  • Vygenerujte opravu z kořenového adresáře vašeho WordPress SVN nebo git checkout. Například svn diff dir/filename.php > function_name.diff.

5. Jak odeslat opravu

existuje jedna oprava pro nahlášení selhání inline dokumentace a
například #48303 je taková oprava pro WordPress 5.4.

  • Přidat komentář a připojit patch soubor.

6. Můžete také přispět k inline Docs související Trac vstupenky, které potřebují iteraci.

  • pokud je lístek označen needs-patch nebo needs-refresh, je možné, že stávající patch(Y) může potřebovat pouze touch-up nebo být obnoven proti nejnovějšímu kufru. Každý kousek pomáhá!

Top

kontaktní místa # kontaktní místa

v případě jakýchkoli dotazů popujte kanály #docs nebo # core-docs v Slack.

Top

Resources # Resources

  • PHP Documentation Standard
  • Adam Brown ‘ s Hooks Database (užitečné pro rady ohledně @since verzí hookshooků v tématu a vývoji WordPress, háčky jsou funkce, které lze použít na akci nebo filtr v WordPress. Akce jsou funkce prováděné při určité události ve WordPressu. Filtry umožňují měnit určité funkce. Argumenty používané k připojení filtrů i akcí vypadají stejně.)

nahoru

jak otevřít nový dokument lístek #jak otevřít nový dokument lístek

v podstatě existuje jeden lístek, který hlásí chyby a vylepšení inline dokumentace. Ale, pokud potřebujete vytvořit nový lístek z nějakého důvodu, postupujte podle následujících kroků:

  1. Přečtěte si otevření lístku a dozvíte se, jak vytvořit lístek Trac.
  2. vytvořte nový lístek na Core Trac pro soubor:
    • navrhované formáty titulků by mohly být ” korekce PHPDoc pro cestu / k / souboru.php “nebo” zlepšit dokumentaci pro cestu / k / souboru.Linux”.
    • Typ by měl být defekt (chyba).
    • přiřaďte tiket komponentě, ke které je soubor přidružen.
    • ponechte verzi prázdnou.
    • přidejte zaostření dokumentů kliknutím na něj.
  3. Nahrajte opravu do Trac tiketu, který jste vytvořili, a přidejte Klíčové slovo has-patch.
  4. nezapomeňte zanechat komentář popisující nově nahranou opravu. Pouhé nahrání záplat nespustí oznámení pro každého, kdo sleduje lístek.

Poznámka: změny dokumentace by se neměly mísit se změnami kódu (dokonce i mezery), pokud lístek výslovně nevyžaduje obojí.

Poslední aktualizace: 26. října 2019

Leave a Reply