Új kódpéldák hozzáadása
Közreműködési irányelvek kódpéldákhoz
- A beküldött anyagoknak kötelezően angol nyelven kell készülniük.
- Dokumentáld a példádat a lehető legalaposabban.
- Győződj meg róla, hogy a kódod működik és megfelelően le van tesztelve.
Fenntartjuk a jogot, hogy:
- A beküldés után módosítsuk az anyagodat.
- Szükség esetén eltávolítsuk a beküldésedet.
Új kódpélda létrehozása
1. Forkold ezt a repositoryt
2. Klónozd a forkodat, és lépj be cd-vel a projekt könyvtárába
3. Telepítsd a VitePresst
A VitePress előfeltételeit megtalálod a hivatalos dokumentációban.
sh
npm add -D vitepress@nextsh
pnpm add -D vitepress@nextsh
yarn add -D vitepress@next vuesh
bun add -D vitepress@next4. Add hozzá a kódpéldádat
4.1 Hozd létre a példafájlt
- Hozz létre egy új fájlt a
/docs/examplesmappában a programozási nyelv nevével. - A fájlnévnek
.mdkiterjesztéssel kell végződnie. - Mutass be legalább két különböző módot az API-hívások elvégzésére.
4.2 Add hozzá a példát az oldalsávhoz
- Nyisd meg a
/docs/.vitepress/config.mtsfájlt. - Keresd meg a "Code Examples" szakaszt az oldalsávban.
- Add hozzá az új fájlodat a listához.
- Tartsd a listát ábécésorrendben a programozási nyelvek neve szerint.
5. Indítsd el a fejlesztői szervert
Mielőtt pull requestet nyitnál, ellenőrizd helyben, hogy a változtatásaid nem rontottak el semmit.
sh
npm run devsh
pnpm run devsh
yarn devsh
bun run dev6. Hozz létre egy Pull Requestet
Nyiss egy pull requestet az eredeti repositoryba.