Készíts letisztult README-t 10 perc alatt a GitHub Copilottal

Nyisd meg a repódat, és kezdj el írni egy README-t

Nyisd meg a repódat a GitHubon, a böngésződben. A főoldalra érkezel, ahol a projekt fájljai látszanak. Keresd meg a fájllistát; ha most hoztad létre a repot, lehet, hogy csak egy .gitignore fájlt látsz, vagy még azt sem. A fájllista jobb felső sarkában kattints az Add file gombra, majd válaszd a Create new file opciót. A fájl neve legyen README.md. A .md a „Markdown" rövidítése — ez egy egyszerű módja a szöveg formázásának, például a # jel használatával a címsorokhoz.

Egy üres szerkesztőt fogsz látni, ezzel a helyőrzővel: „Write a new file in …". A README.md fájlnév jelzi a GitHubnak, hogy ez a projekt üdvözlőoldala.

README.md

Akkor csináltad jól, ha a fájl neve (README.md) megjelenik a szerkesztő tetején, és az oldal címe „Create new file".

Kérd meg a Copilotot, hogy állítsa össze a README vázát

A megnyitott fájlnál kattints az Ask Copilot gombra (általában egy chat- vagy csillag ikon) a szerkesztő jobb felső sarkában. Ha nem találod, keresd a Copilot ikont az eszköztárban, vagy használd a Ctrl+I (Windows/Linux) illetve a Cmd+I (Mac) billentyűkombinációt. A jobb oldalon megnyílik egy csevegőpanel.

A csevegőmezőbe írd be:

Nyomd meg az Entert. A Copilot egy javasolt vázat fog mutatni Markdown címsorokkal, például # Description, ## Features stb. Az egyes címsorok alá rövid helyőrző bekezdéseket is fűzhet.

Akkor csináltad jól, ha megjelennek a címsorok és a rövid leírások a szerkesztőben, felváltva az üres lapot.

Töltsd ki a projekt leírását

Görgess le a Copilot által létrehozott # Description szekcióhoz. Cseréld ki a helyőrző szöveget a projekted egy világos, egymondatos ismertetésére. Ha például a projekted egy szószámláló Python-szkript, írhatsz valami ilyesmit:

Akkor csináltad jól, ha a leírás barátságos bevezetőként olvasható, és természetesen simul a címsor alá.

Sorold fel a projekt funkcióit

A ## Features címsor alatt a Copilot valószínűleg már elhelyezett egy felsorolást. Cseréld ki az egyes pontokat rövid, cselekvő megfogalmazásokra, amelyek leírják, mit tud a projekted. Egy szószámlálónál ez valahogy így nézhet ki:

• Windows, macOS és Linux alatt egyaránt működik .txt fájlokkal
• Pehelysúlyú, másodpercek alatt lefut
• Nem igényel külső könyvtárakat

Akkor csináltad jól, ha a lista egyszerű nyelven, világosan mutatja be, mit tud a projekt.

Telepítési útmutató hozzáadása

Görgess a ## Installation szakaszhoz. A Copilot általában javasol parancsokat, például pip install vagy git clone. Cseréld ki a helyőrzőt operációs rendszeredhez illő, lépésről lépésre haladó útmutatóra. Egy kezdőbarát Python-projekthez például ezt írhatod:

python --version Ha a Python 3.x feliratot látod, minden rendben. 2. Töltsd le vagy klónozd a projektet: git clone https://github.com/a-te-felhasznaloneved/a-te-repod.git 3. Lépj be a projekt mappájába: cd a-te-repod 4. Telepítsd a szükséges csomagokat (ha vannak): pip install -r requirements.txt (Ha nincs requirements.txt fájl, ezt a lépést kihagyhatod.)

Akkor csináltad jól, ha az útmutató elég érthető ahhoz, hogy egy alapvető számítógépes ismeretekkel rendelkező ember is gond nélkül kövesse.

Készíts egy használati példát

A ## Usage címsor alatt a Copilot gyakran egy kódblokkot szúr be, valami olyasmi paranccsal, mint python wordcounter.py. Cseréld ki egy rövid, másolásra és beillesztésre kész példára. Szószámláló esetén például ez állhat ott:

python wordcounter.py sample.txt

Akkor csináltad jól, ha a példa rövid, valódi fájlneveket használ, és pontosan megmutatja, mit kell beírni.

Válassz licencet, és add hozzá

Görgess a ## License szakaszhoz. A Copilot felajánlhat helyőrzőnek valamit, például „MIT License" vagy „Apache 2.0". Cseréld ki egy rövid magyarázatra és a licencfájlra mutató hivatkozásra. Kezdőknek az MIT License egyszerű és széles körben elterjedt. Írd be például:

Akkor csináltad jól, ha a licencszekció egyértelműen megnevezi a licenc típusát, és hivatkozik a repódban található LICENSE fájlra.