Commitüzenetek

A commitüzeneteknél a Conventional Commits stílusát követjük. Nem minden javaslat alkalmazható a Privacy Guides esetében; főként az alábbi típusokat használjuk.

Meglévő szöveg frissítése

Az alábbi példa olyan elemhez használható, amely már szerepel a webhelyen, de a leírásán kisebb módosítás történik.

update: Add mention of security audit (#0000)

Ajánlások vagy oldalak hozzáadása és eltávolítása

Ez a példa egy elem hozzáadásához vagy eltávolításához használható. Az eltávolítás okát a commitüzenet következő bekezdésében részletesebben is kifejtheted. Figyeld meg a plusz ! jelet, amely egy jelentős változásra hívja fel a figyelmet.

update!: Remove foobar (#0000)

Foobar was removed due to it having numerious security issues and being unmaintained.

A ! valójában az ezen az oldalon szereplő bármely típushoz hozzáadható egy különösen nagy horderejű változás jelölésére, de általában ebben az esetben a legindokoltabb.

Új funkció vagy továbbfejlesztés

A webhely új funkcióihoz és fejlesztéseihez — például amelyek a GitHubon enhancements címkét kapnak — a következő forma használható:

feat: Add blah blah (#0000)

This change adds the forum topics to the main page

Apró változtatások

Kisebb módosítások, amelyek nem változtatják meg a cikk jelentését, például elírás vagy nyelvtani hiba javítása, formázás vagy szóközök módosítása, CSS-frissítések stb.

style: Typo correction in VPN overview

Fejlesztéshez kapcsolódó típusok

Ezeket a commit-típusokat jellemzően olyan változásokhoz használjuk, amelyeket az általános közönség közvetlenül nem lát.

A fix: előtag a webhely hibáit javító változásokhoz használatos. Ezek a GitHubon általában bug címkét kapnak.

fix: Remove broken Invidious embeds (#0000)

A docs: a webhely fejlesztői dokumentációjának módosításait jelöli, beleértve többek között a README fájlt, valamint a /docs/about és /docs/meta legtöbb oldalát:

docs: Update Git commit message guidelines (#0000)

A build: a buildfolyamathoz kapcsolódó commitokhoz használatos, főként függőségfrissítésekhez.

build: Bump modules/mkdocs-material from 463e535 to 621a5b8

A ci: a GitHub Actions, DevContainers és más automatizált buildplatformok módosításait jelöli.

ci: Update Netlify config (#0000)

A refactor: olyan változásokhoz használatos, amelyek nem hibát javítanak és nem új funkciót adnak hozzá, például fájlok átrendezése vagy a navigáció sorrendjének módosítása.

refactor: Move docs/assets to theme/assets

A Magánszféra Kalauz a Privacy Guides nem hivatalos magyar változata. Tartalmi eltérés esetén az angol eredeti az irányadó. Eredeti Privacy Guides