Változások naplója sablon

A Keep a Changelog konvenciókat követő szoftverprojekt változásnapló sablonja.

# Változásnapló (Changelog) sablon: Az alapvető eszköztár professzionális projekt-dokumentációhoz Egy szoftverprojekt karbantartása többről szól, mint a kódolásról; a munka folyamatának kommunikálásáról a felhasználók, a közreműködők és a saját jövőbeli éned felé. Mégis, sok fejlesztő számára a CHANGELOG.md fájl frissítése gyakran utólagos feladattá válik, vagy teljesen elfelejtődik a kiadások hevében. A "Changelog Template" egy olyan Chrome-bővítmény, amelyet azért hoztunk létre, hogy áthidalja ezt a szakadékot, egyszerű, intuitív és professzionális munkafolyamatot biztosítva az ipari szabványokat követő, kiváló minőségű változásnaplók vezetéséhez. ## Az alapvető cél: Jobb kommunikáció a "Keep a Changelog" révén A Changelog Template lényege, hogy segítse a szoftverprojekteket a "Keep a Changelog" (Vezess változásnaplót) konvenciók betartásában. A jó változásnapló a projekt minden egyes verziójához tartozó fontosabb változások gondosan összeállított, időrendi listája. Ez nem a git commit-ok nyers kiírása; ez egy embereknek szánt dokumentum. A bővítmény használatával biztosíthatod, hogy a projekted története olvasható, rendszerezett és hasznos legyen. Akár egy kisebb mellékprojektet, egy nagy nyílt forráskódú könyvtárat vagy belső eszközök készletét kezeled, a Changelog Template megadja azt a struktúrát, amelyre szükséged van az átláthatóság és a professzionalizmus fenntartásához anélkül, hogy lassítaná a fejlesztési ciklust. ## Megbízható, szabványos formátum A bővítmény szigorúan igazodik a szabványos változásnapló-formátumhoz, biztosítva, hogy a dokumentációd professzionális megjelenésű legyen és kompatibilis maradjon a szélesebb ökoszisztémával. Minden általad létrehozott bejegyzés a "Keep a Changelog" projekt által ajánlott hat szabványos változástípus egyikébe sorolható: 1. **Added (Hozzáadva):** Új funkciókhoz, amelyek bővítik a szoftver képességeit. 2. **Changed (Módosítva):** Meglévő funkciók változásaihoz, amelyek befolyásolják a működést. 3. **Deprecated (Elavult):** A hamarosan eltávolításra kerülő funkciókhoz, figyelmeztetve a felhasználókat a migrációra. 4. **Removed (Eltávolítva):** A kódbázisból hivatalosan kivezetett funkciókhoz. 5. **Fixed (Javítva):** Hibajavításokhoz, amelyek megoldják a problémákat és javítják a stabilitást. 6. **Security (Biztonság):** A sebezhetőségeket kezelő kritikus javításokhoz. Ez a kategorizálás segít a felhasználóknak gyorsan áttekinteni a kiadási megjegyzéseket, hogy megtalálják pontosan azt, amire szükségük van, legyen szó új eszközökről vagy egy adott hiba javításának ellenőrzéséről. ## Útmutató a hatásos bejegyzések írásához A jó változásnapló-bejegyzés írása művészet. Megköveteli a technikai pontosság és az érthetőség egyensúlyát. A Changelog Template nem csak egy szövegdobozt ad; biztosítja a szükséges környezetet és útmutatást az igazán lényeges bejegyzések megírásához. Három egyszerű szabályt javaslunk: - **Használj rövid, egysoros mondatokat:** Légy tömör. Egy világos pont bejegyzésenként jobb, mint egy sűrű bekezdés. - **Használj múlt időt:** Azt írod le, ami *megváltozott* (pl. "Javított keresési teljesítmény" a "Javítsd a keresési teljesítményt" helyett). - **Vedd figyelembe a felhasználói perspektívát:** Annak írj, aki használja a szoftvert, ne annak, aki írta a kódot. A "Refaktorált SQL lekérdezés-optimalizáló" helyett írd azt, hogy "A keresési teljesítmény 50%-kal javult." A bővítmény még a mechanikai részekben is segít – automatikusan nagybetűvel kezdi a bejegyzéseket, és biztosítja, hogy ponttal végződjenek, ha véletlenül kifelejtenéd. ## Funkciógazdag munkaterület A Changelog Template tele van olyan funkciókkal, amelyek a dokumentálást a munkafolyamat természetes részévé teszik: ### 1. Gyors bejegyzéskészítés A "Create" (Létrehozás) fül a kezdőpontod. Válaszd ki a változás típusát, írd be a szöveget, és nyomd meg az "Add to Unreleased" (Hozzáadás a kiadatlanhoz) gombot. Ilyen egyszerű. Nincs több környezetváltás az IDE és a Markdown fájl között csak egy gyors frissítés feljegyzéséhez. ### 2. Állandó "Unreleased" (Kiadatlan) kezelés A jó változásnapló egyik legerősebb funkciója az "Unreleased" szekció. Ez egy átmeneti tároló az összes változtatáshoz, amit az utolsó hivatalos verzió óta készítettél. A Changelog Template kezeli helyetted ezt a szakaszt, a helyi tárhelyen tárolva a bejegyzéseidet, így azok mindig elérhetőek, amikor megnyitod a bővítményt. ### 3. Szemantikus verziózás (SemVer) referencia A verziózás ne legyen találgatás. A "Reference" (Referencia) fülünk tartalmaz egy gyorstalpalót a szemantikus verziózáshoz (SemVer), ami segít eldönteni, hogy a következő kiadásod Major, Minor vagy Patch verzió legyen: - **MAJOR:** Inkompatibilis API-változások esetén. - **MINOR:** Visszafelé kompatibilis funkciók hozzáadásakor. - **PATCH:** Visszafelé kompatibilis hibajavítások esetén. ### 4. Automatizálási eszközök referenciája Azoknak a csapatoknak, amelyek készen állnak a következő lépésre, útmutatást adunk az ipari szabványú automatizálási eszközökhöz, mint a `standard-version`, a `release-it` és a `semantic-release`. Ezek az eszközök kéz a kézben működnek a bővítményünk által generált Markdown formátummal, hogy automatizálják a teljes kiadási folyamatot. ### 5. Egykattintásos másolás és Markdown export Ha készen állsz a fájl frissítésére, egyetlen kattintással másolhatod az "Unreleased" szakaszt formázott Markdownként. Új projektet kezdenél? Használd a "Full CHANGELOG.md Starter Template"-ünket egy komplett, sablon fájl létrehozásához, amely tartalmazza a szükséges fejléceket és hivatkozásokat. ## Miért fontos a jó változásnapló? A jól karbantartott változásnapló több, mint frissítések listája; egy egészséges, érett projekt jele. **Átláthatóságot** épít azáltal, hogy megmutatja a felhasználóknak: a projektet aktívan karbantartják. Elősegíti a **kommunikációt** azáltal, hogy kiemeli a fontos változásokat, amelyek egyébként több száz commit üzenet közé temetve maradnának. Mindenekelőtt pedig **professzionalizmust** sugároz. Amikor egy felhasználó egy tiszta, rendezett CHANGELOG.md fájlt lát, tudja, hogy bízhat a projektben és az azt fejlesztőben. ## Kinek szól ez? - **Szóló fejlesztőknek:** Tartsd rendben a mellékprojektjeidet, és kerüld el a "mit is csináltam három hónapja?" pillanatokat. - **Kis csapatoknak:** Biztosítsd, hogy mindenki ugyanazon az oldalon álljon a projekt előrehaladását illetően, anélkül, hogy bonyolult Jira-táblákra lenne szükség minden kisebb frissítéshez. - **Nyílt forráskódú közreműködőknek:** Tedd hívogatóbbá a projekted az új felhasználók számára azzal, hogy világos, könnyen olvasható kiadási megjegyzéseket biztosítasz. ## Egyszerű használat: Nincs beállítás, nincs gond A Changelog Template úgy lett tervezve, hogy láthatatlan maradjon, amíg nincs rá szükséged. Nincs bonyolult beállítás, nincsenek külső fiókok, és nincsenek kezelendő API-kulcsok. A Chrome helyi tárhelyét használja, hogy adataid privátak maradjanak és csak a te gépeden legyenek elérhetőek. A felhasználói felület minimalista és reszponzív, tökéletesen illeszkedik a böngésződ oldalsávjába vagy a felugró ablakába. Ne hagyd, hogy a projekt dokumentációd elmaradjon. Kezd el használni a **Changelog Template**-et még ma, és add meg a szoftverednek azt a professzionális történelmet, amelyet megérdemel.