WordPress.org

a WordPress jelenlegi inline dokumentációs erőfeszítései valóban elindultak a 3.7 kiadási ciklusban, és lendületet kaptak a hook docs kezdeményezés előrehaladtával. Az inline dokumentáció, vagy az “inline docs” kezdeményezés egy hibrid projekt, a CoreCore Core-nak történő jelentéstétel a WordPress futtatásához szükséges szoftverkészlet. Az Alapfejlesztő csapat épít WordPress., Dokumentációs és fejlesztői Hub csapatok.

mi az inline dokumentáció? #Mi az inline dokumentáció?

az Inline dokumentáció mind szükséges, mind hasznos információkat tartalmaz inline megjegyzések, doc blokkok és még sok más formájában a WordPress forráskódjában.

az inline dokumentációt minden kiadásnál elemezzük, és ez a dokumentáció megjelenik a Kódhivatkozásban developer.wordpress.orgWordPress.org az a közösségi oldal, ahol a WordPress kódot létrehozzák és megosztják a felhasználók. Itt töltheti le a WordPress core, plugins és themes forráskódját, valamint a közösségi beszélgetések és szervezés központi helyét. https://wordpress.org/.

Top

hogyan lehet bekapcsolódni #hogyan lehet bekapcsolódni

az Inline dokumentációt “műszaki” dokumentációnak tekintik, ezért szükség lesz a WordPress kódbázis ismeretére – meg kell értenie a kódot, hogy írjon róla.

1. Ismerkedjen meg a PHP Dokumentációs szabványával, valamint a formázási irányelvekkel és a dokumentálási tippekkel.

2. Állítsa be a WordPress kódbázis fejlesztői verziójának helyi példányát a változó Vagrant Vagrants (VVV) használatával. A WordPress az SVNSVN Apache Subversion (gyakran rövidítve SVN, a parancs neve után svn)egy szoftververzió-és revízióvezérlő rendszer. A szoftverfejlesztők a Subversion használatával fenntartják a fájlok jelenlegi és korábbi verzióit, például a forráskódot, a weboldalakat és a dokumentációt. Célja, hogy a széles körben használt Concurrent Versions System (CVs) leginkább kompatibilis utódja legyen. WordPress core és a wordpress.org a kiadott kódokat mind központilag kezelik az SVN-en keresztül. https://subversion.apache.org/., de használhatja a GitGit-et is a Git egy ingyenes és nyílt forráskódú elosztott verziókezelő rendszer, amelyet úgy terveztek, hogy a kicsitől a nagyon nagy projektekig mindent gyorsan és hatékonyan kezeljen. A Git könnyen megtanulható, apró lábnyommal rendelkezik, villámgyors teljesítménnyel. A legtöbb modern plugin és téma fejlesztés történik ezzel a verziókezelő rendszerrel. https://git-scm.com/. (a VVV link, hogyan kell csinálni, hogy).

3. Olvassa megnyitása jegyet, hogy megtanulják, hogyan kell létrehozni egy TracTrac Trac az a hely, ahol közreműködők létre kérdéseket hibákat vagy szolgáltatás kérések hasonlóan GitHub.https://core.trac.wordpress.org/. jegy.

4. Javítások létrehozása:

• a fájl szerkesztése és javítások létrehozása előtt mindig frissítse a WordPress trunk helyi példányát. Használja a svn up vagy git pull értéket.
• generálja a javítást a WordPress SVN vagy a Git pénztár gyökérkönyvtárából. Például svn diff dir/filename.php > function_name.diff.

5. Javítás beküldése

van egy javítás az inline dokumentációs hibák bejelentésére és
például a #48303 ilyen javítás a WordPress 5.4-hez.

• Megjegyzés hozzáadása és patch Fájl csatolása.

6. Ön is hozzájárulhat inline docs kapcsolatos Trac jegyeket, hogy szükség iteráció.

• ha egy jegy van jelölve needs-patch vagy needs-refresh, akkor lehetséges, hogy a meglévő patch(ek) lehet, hogy csak kell egy touch-up, vagy frissíteni kell a legújabb törzs. Minden kis segítség!

Top

érintkezési pontok #érintkezési pontok

ha bármilyen kérdése van, pop a #docs vagy #core-docs csatornák Slack.

Top

Resources #Resources

• PHP Documentation Standard
• Adam Brown Hooks Database (hasznos tippeket a @since változatai hooksHooks WordPress téma és fejlesztés, hooks olyan funkciók, hogy lehet alkalmazni, hogy egy művelet vagy egy szűrő a WordPress. A műveletek olyan funkciók, amelyeket akkor hajtanak végre, amikor egy bizonyos esemény bekövetkezik a WordPress programban. A szűrők lehetővé teszik bizonyos funkciók módosítását. Mind a szűrők, mind a műveletek összekapcsolására használt argumentumok ugyanúgy néznek ki.)

Top

hogyan lehet új dokumentumjegyet megnyitni #hogyan lehet új dokumentumjegyet megnyitni

alapvetően van egy jegy, amely jelenti az inline dokumentációs hibákat és fejlesztéseket. De, ha szüksége van új jegy létrehozása valamilyen okból, kövesse az alábbi lépéseket:

1. olvassa el a Jegy megnyitását, hogy megtudja, hogyan hozhat létre Trac jegyet.
2. hozzon létre egy új jegyet a Core Trac-on a fájlhoz:
   • a javasolt Címformátumok lehetnek “PHPDoc javítás az elérési úthoz/fájlhoz.php “vagy” javítsa az elérési út/fájl dokumentációját.php”.
   • a típusnak hibának (hibának) kell lennie.
   • rendelje hozzá a jegyet ahhoz az összetevőhöz, amelyhez a fájl társítva van.
   • hagyja üresen a verziót.
   • kattintson rá a dokumentumok fókuszának hozzáadásához.
3. töltse fel a javítást a létrehozott Trac jegyre, majd adja hozzá a has-patch kulcsszót.
4. ügyeljen arra, hogy hagyjon megjegyzést az újonnan feltöltött javításról. A javítások egyszerű feltöltése nem vált ki értesítést bárki számára, aki figyeli a jegyet.

Megjegyzés: A dokumentáció módosításai nem keveredhetnek kódváltozásokkal (még szóközökkel sem), kivéve, ha a jegy kifejezetten mindkettőt kéri.

Utolsó frissítés: Október 26, 2019