Felkészülés az indulásra

Mielőtt készen állnál a kurzusod elindítására, győződj meg róla, hogy az alábbi tennivalókat elvégezted.

Kurzusikon igénylése

Ahhoz, hogy ikont tervezhessenek a webhelyhez, nyiss egy új issue-t az exercism/website-icons tárolóban, és válaszold meg a következő kérdéseket:

  • Van a nyelvnek hivatalos logója? Ha igen,
    • mellékelj egy linket egy példához
    • sorold fel a szerzőség feltüntetésével kapcsolatos követelményeket és a logó használatára adott jogokat
  • Van a nyelvnek nem hivatalos logója? Ha igen,
    • magyarázd el, hogyan szokták használni az emberek a nem hivatalos logót
    • mellékelj egy linket egy példához
    • sorold fel, milyen szerzőségfeltüntetési követelmények vonatkoznak arra a logóra

Kurzusdokumentáció hozzáadása

Add hozzá a következő kurzusdokumentumokat:

  • docs/ABOUT.md: rövid bevezetés a nyelvbe.
  • docs/INSTALLATION.md: írd le, mit kell telepítenie a tanulónak ahhoz, hogy a parancssori felület használatával a saját gépén dolgozhasson a kurzuson.
  • docs/LEARNING.md: linkek tanulási forrásokhoz.
  • docs/RESOURCES.md: linkek hasznos forrásokhoz.
  • docs/TESTS.md: írj le mindent, ami a kurzuson a tesztek futtatásához kapcsolódik.

Ezek a dokumentumok segítenek a tanulónak elkezdeni a kurzust, valamint megismerni a kurzust és annak nyelvét. További információért lásd a dokumentációt.

Feladatdokumentáció hozzáadása

Add hozzá a következő feladatdokumentumokat:

  • exercises/shared/.docs/help.md: a kurzushoz kapcsolódó utasításokat tartalmaz arról, hogyan kérhetsz segítséget
  • exercises/shared/.docs/tests.md: a kurzushoz kapcsolódó utasításokat tartalmaz arról, hogyan futtathatod a teszteket

Kódrészlet hozzáadása

Adj hozzá egy kódrészletet a docs/SNIPPET.txt fájlhoz. Ez a részlet vizuális benyomást ad arról, hogyan néz ki a nyelv szintaxisa. További információért lásd a dokumentációt.

Metaadatok frissítése

A kurzus metaadatai a config.json fájlban vannak meghatározva. A következő tulajdonságokat kell frissíteni:

  • language: a kurzus nyelve (pl. "C#"). A hossza nem haladhatja meg a 255-öt
  • slug: a kurzus nyelve kisbetűs, kebab-case formában (pl. "csharp"). A hossza nem haladhatja meg a 255-öt
  • blurb: a nyelv rövid leírása. A hossza nem haladhatja meg a 400-at
  • online_editor: az online szerkesztőhöz használt beállításokat leíró objektum:
    • indent_style: "space" vagy "tab"
    • indent_size: a behúzás mérete egész számként (pl. 4)
    • highlightjs_language: a Highlight.js nyelvazonosítója (lásd az azonosítók teljes listáját). Ha a Highlight.js nem támogatja a nyelvet, ez a mező elhagyható.
  • key_features: a nyelv fő jellemzői, amelyek tömören leírják annak legfontosabb tulajdonságait. További információért lásd a fő jellemzők dokumentációját.
  • tags: add meg az erre a kurzusra vonatkozó címkéket, amelyek segítségével rá lehet keresni a webhelyen. További információért és a támogatott címkék listájáért lásd a címkék dokumentációját.