CONTRIBUTING.hu.md

   1 <!-- omit in toc -->
   2 # Hozzájárulási útmutató
   3
   4 Tartalomjegyzék:
   5
   6 - [Előfeltételek](#előfeltételek)
   7 - [Projekt beállítása](#projekt-beállítása)
   8 - [Új szabályok hozzáadása](#új-szabályok-hozzáadása)
   9
  10 ## Előfeltételek
  11
  12 Mielőtt hozzájárulnál a projekthez, győződj meg róla, hogy a következő eszközök telepítve vannak a rendszeredben:
  13
  14 - [Node.js][nodejs-download-link] (ajánlott a legfrissebb LTS verzió)
  15 - [Git][git-download-link]
  16
  17 Az legjobb fejlesztési élmény érdekében javasoljuk, hogy a [Visual Studio Code][vscode-download-link]-ot használd kód
  18 szerkesztőként. Ha a VS Code-ot választod, fontold meg a projekt
  19 [ajánlott kiegészítőinek][recommended-vscode-extensions] telepítését.
  20
  21 ## Projekt beállítása
  22
  23 1. Fork-old a [`hufilter/hufilter`][hufilter-repo] tárolót a GitHub-on.
  24 2. Klónozd a fork-olt tárolódat.
  25 3. Engedélyezd a Corepack-ot a `corepack enable` parancs futtatásával. A Corepack előre telepítve van a Node.js-el,
  26    így nem kell külön telepítened.
  27 4. Telepítsd a projekt függőségeit a `pnpm install` paranccsal. Ha nincs telepítve a pnpm, a Corepack
  28    felajánlja a telepítését, ha futtatod a `pnpm` parancsot.
  29
  30 ## Új szabályok hozzáadása
  31
  32 > [!IMPORTANT]
  33 > A hufilter EasyList és EasyPrivacy listákat egészíti ki. Győződj meg arról, hogy a szabályaid nem szerepelnek ezekben
  34 > a listákban.
  35
  36 1. Hozz létre egy új branch-et (ágat) a változtatásaidhoz, például `git checkout -b example.com` vagy
  37    `git checkout -b fix/123` (például ha az `123` azonosítójú issue-t javítod). Fontos, hogy mindig hozz létre külön
  38    ágat minden webhely / issue esetében.
  39 2. Végezd el a változtatásokat az [sections][sections-directory] könyvtárban található szekciófájlok szerkesztésével,
  40    amelyek tartalmazzák a szűrési szabályokat. A könyvtárstruktúra részleteiért lásd a
  41    [`sections/README.hu.md`][sections-readme] fájlt.
  42 3. Commit-old a változtatásaidat, majd push-old őket a forkolt tárolódba.
  43 4. Hozz létre egy pull request-et a forkolt tárolód megfelelő ágáról a `hufilter/hufilter` tároló `master` ágára.
  44 5. Várd meg a változtatásaid felülvizsgálatát.
  45
  46 <!--markdownlint-disable MD013-->
  47 > [!TIP]
  48 > Ha még nem vagy jártas a szűrőszabályok szintaxisában, nézd meg az alábbi dokumentációkat:
  49 >
  50 > - <img src="https://cdn.adguard.com/website/github.com/AGLint/abp_logo.svg" width="14px"> [Adblock Plus: *How to write filters*][abp-filters]
  51 > - <img src="https://cdn.adguard.com/website/github.com/AGLint/adg_logo.svg" width="14px"> [AdGuard: *How to create your own ad filters*][adg-filters]
  52 > - <img src="https://cdn.adguard.com/website/github.com/AGLint/ubo_logo.svg" width="14px"> [uBlock Origin: *Static filter syntax*][ubo-filters]
  53 >
  54 > Ezek a dokumentációk feltételezik, hogy ismered a webtechnológiák alapjait, például az HTML-t, a CSS-t és a JavaScript-et.
  55 <!--markdownlint-enable MD013-->
  56
  57 [abp-filters]: https://help.adblockplus.org/hc/en-us/articles/360062733293
  58 [adg-filters]: https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters
  59 [git-download-link]: https://git-scm.com/downloads
  60 [hufilter-repo]: https://github.com/hufilter/hufilter
  61 [nodejs-download-link]: https://nodejs.org/en/download/
  62 [recommended-vscode-extensions]: https://github.com/hufilter/hufilter/blob/master/.vscode/extensions.json
  63 [sections-directory]: https://github.com/hufilter/hufilter/blob/master/sections/
  64 [sections-readme]: https://github.com/hufilter/hufilter/blob/master/sections/README.hu.md
  65 [ubo-filters]: https://github.com/gorhill/uBlock/wiki/Static-filter-syntax
  66 [vscode-download-link]: https://code.visualstudio.com/download