Ako prispieť modulu Drupal 8 do komunity?
Predtým, ako sa rozhodnete prispieť modulom do komunity Drupal, a dokonca aj pred vytvorením modulu, uistite sa, že už neexistuje modul, ktorým by prispel niekto iný a ktorý robí to isté.
Drupal je nástroj na vytváranie webových stránok. Konkrétnejšie ide o systém správy obsahu s otvoreným zdrojovým kódom (vyvinutý komunitou). To znamená, že sa spolieha na to, že ho členovia komunity (ako vy) vylepší. Našťastie prispievanie vlastnými modulmi je niečo, čo môže urobiť každý.
Časť 1 z 3: Príprava modulu
- 1Neobnovujte koleso (okrem cvičenia). Predtým, ako sa rozhodnete prispieť modulom do komunity Drupal a dokonca aj pred vytvorením modulu, uistite sa, že už neexistuje modul, ktorým by prispel niekto iný a ktorý robí to isté. Ak existuje, je pravdepodobne lepšie podporovať modul, ktorý si vytvoríte vlastný.
- 2Vytvorte modul (ak ste to ešte neurobili). Ak ste svoj modul ešte nevytvorili, zvážte použitie konzoly Drupal (veľmi užitočného vývojového nástroja), ktorá vám ho pomôže zostaviť. Akonáhle je nainštalovaný, jednoducho spustite príkaz
$ drupal generate:modulea$ drupal module:install {name} - 3Zbaľte to na rozdávanie. Hneď ako bude váš modul pripravený na zverejnenie, pridajte súbor README.md (markdown), ktorý vysvetľuje všetko, čo by niekto, kto používa váš modul, potreboval vedieť. Napríklad:
- Úvod. (čo to robí, pre koho je to)
- Vlastnosti
- Požiadavky (ďalšie moduly atď.)
- Časté otázky
- Inštalácia
- Použitie (ako ho používa vývojár / vlastník webu / návštevník webu)
- Riešenie problémov
- Technické poznámky (konštrukcia, nástroje atď.)
- Správcovia (jednotlivci, firmy)
- 4Zaviazať sa k git. Pri zadávaní kódu postupujte podľa štandardného postupu. Predtým sa však uistite, že máte súbor .gitignore. Potom použite
init,addacommitpríkazy.
Ak ste svoj modul ešte nevytvorili, zvážte použitie konzoly Drupal (veľmi užitočného vývojového nástroja), ktorá vám ho pomôže zostaviť.
Časť 2 z 3: doručenie na drupal.org
- 1Prihláste sa na drupal.org. Ak nemáte účet, vytvorte si ho. Potom sa prihláste.
- 2Vytvorte nový projekt. Prejdite na → Váš „Účet“ → Stránka „Projekty“ → „Pridať nový projekt“ → „Modulový projekt“.
- 3Vyplňte nový formulár projektu. Najlepšie je, ak poskytnete užitočné informácie ľuďom, ktorí sa rozhodujú, či si majú stiahnuť a používať váš modul; Môžete to vziať zo svojho súboru README, ak ste ho vytvorili skôr (ale vynechajte technické záležitosti).
- 4Prejdite na stránku drupal.org. Jednoducho postupujte podľa uvedených pokynov.
- 5Vytvorte vydanie. Prejdite na „Upraviť“ → „Vydania“ → „Pridať nové vydanie“. Ak ste kód zadali správne, zobrazí sa vám možnosť vytvoriť nové vydanie.
- 6Vyplňte nový formulár vydania. Pozrite si konvencie pomenovania vydaní a časť Vytvorenie vydania projektu na Drupal.org.
- 7Pochopte vydania a zabezpečenie. Vývojár → Alpha → Beta → RC → Stabilný. Ak chcete pre svoj modul získať bezpečnostné krytie (zelený odznak), musíte požiadať o overený stav vo fronte pokrytia bezpečnostným poradenstvom. Členovia bezpečnostného tímu alebo iní dobrovoľníci vašu žiadosť posúdia - a môžu navrhnúť zmeny vo vašom projekte. Akonáhle bude spätná väzba vyriešená, bude vám udelená overená rola a budete sa môcť prihlásiť do tohto projektu a všetkých budúcich projektov, ktoré vytvoríte, a získať krytie poradenstva v oblasti bezpečnosti.
- Iba stabilné vydania dostávajú poradenstvo o zabezpečení, takže okrem stabilných vydaní nedostanete štít poradného pokrytia ani po prihlásení sa do svojho projektu.
Ak chcete pre svoj modul získať bezpečnostné krytie (zelený odznak), musíte požiadať o overený stav vo fronte pokrytia bezpečnostným poradenstvom.
Časť 3 z 3: zlepšenie
- 1Dodržiavajte štandardy kódovania. Drupal má štandardy pre spôsob formátovania kódu. Napríklad karty sú uprednostňované pred medzerami. Pozrite si štandardy kódovania na Drupal.org. Pozrite si tiež sprievodcu štýlom značenia Drupal a dokonca aj bezpečnostné štandardy Drupal. Zvážte použitie modulu Coder, ktorý vám môže pomôcť zaistiť správne formátovanie kódu.
- 2Napíšte testy. Vďaka testom sa zaistí, že váš kód bude fungovať častejšie vo viacerých prípadoch použitia a prinesie menej frustrácie, keď potrebujete opraviť chyby. Zvážte použitie jednotkových testov, funkčných testov atď. Drupal 8 používa na testovanie PHP predovšetkým PHPUnit. Zvážte použitie Behatu na funkčné testovanie.
- 3Napíšte dokumentáciu (ak je váš modul zložitý). Pozrite si phpDocumentor. Intuitívny kód je v podstate ešte lepší ako komentáre, čo je rozhodne lepšie ako žiadne komentáre.
- 4Riešenie problémov pomocou opráv. Pravidelne kontrolujte vo fronte problémov svojho modulu veci, ktoré je potrebné opraviť. Ak chcete použiť opravu, môžete použiť príkaz git alebo „patch“ (vo väčšine verzií systému Linux).
Prečítajte si tiež: Ako vytvoriť ukazovatele v jazyku C?
Súvisiace články
