Šablon zapisa promena

Šablon zapisa promena za softverski projekat u skladu sa konvencijama Keep a Changelog.

# Predložak za dnevnik promjena (Changelog): Osnovni alat za profesionalnu dokumentaciju projekta Održavanje softverskog projekta podrazumijeva mnogo više od pukog pisanja koda; radi se o komuniciranju razvoja vašeg rada korisnicima, suradnicima i vama samima u budućnosti. Ipak, za mnoge programere, zadatak ažuriranja datoteke CHANGELOG.md često ostaje u drugom planu ili se potpuno zaboravi u žurbi oko objave verzije. "Changelog Template" je proširenje za preglednik Chrome dizajnirano da premosti ovaj jaz, pružajući jednostavan, intuitivan i profesionalan tijek rada za održavanje visokokvalitetnih dnevnika promjena koji slijede industrijske standarde. ## Ključna svrha: Bolja komunikacija kroz "Keep a Changelog" U svojoj osnovi, Changelog Template je napravljen kako bi pomogao softverskim projektima da se pridržavaju konvencija "Keep a Changelog". Dobar dnevnik promjena je kuriran, kronološki poredan popis značajnih izmjena za svaku verziju projekta. To nije sirovi ispis git commit-a; to je dokument napisan za ljude. Korištenjem ovog proširenja osiguravate da povijest vašeg projekta bude čitljiva, organizirana i korisna. Bez obzira upravljate li malim sporednim projektom, velikom bibliotekom otvorenog koda ili skupom internih alata, Changelog Template pruža strukturu koja vam je potrebna za održavanje transparentnosti i profesionalizma bez dodavanja prepreka u vaš razvojni ciklus. ## Standardizirani format kojem možete vjerovati Proširenje je strogo usklađeno sa standardnim formatom dnevnika promjena, osiguravajući da vaša dokumentacija izgleda profesionalno i ostane kompatibilna sa širom ekosustavom. Svaki unos koji kreirate kategoriziran je u jednu od šest standardnih vrsta promjena koje preporučuje projekt "Keep a Changelog": 1. **Dodano (Added):** Za nove značajke koje proširuju mogućnosti vašeg softvera. 2. **Promijenjeno (Changed):** Za promjene u postojećoj funkcionalnosti koje mijenjaju način rada stvari. 3. **Zastarjelo (Deprecated):** Za značajke koje će uskoro biti uklonjene, dajući korisnicima upozorenje da migriraju. 4. **Uklonjeno (Removed):** Za značajke koje su službeno uklonjene iz koda. 5. **Popravljeno (Fixed):** Za sve ispravke grešaka koje rješavaju probleme i poboljšavaju stabilnost. 6. **Sigurnost (Security):** Za kritične zakrpe koje rješavaju ranjivosti. Ova kategorizacija pomaže korisnicima da brzo pretraže vaše napomene o izdanju kako bi pronašli točno ono što im treba, bilo da traže nove alate za korištenje ili provjeravaju je li određena greška ispravljena. ## Upute za pisanje dojmljivih unosa Pisanje dobrog unosa u dnevnik promjena je umjetnost. Zahtijeva balansiranje tehničke točnosti i pristupačnosti. Changelog Template vam ne daje samo okvir za tekst; pruža kontekst i smjernice potrebne za pisanje unosa koji su važni. Zalažemo se za tri jednostavna pravila: - **Koristite rečenice u jednini:** Budite sažeti. Jedna jasna točka po unosu je bolja od gustog odlomka. - **Koristite prošlo vrijeme:** Opisujete ono što se *promijenilo* (npr. "Poboljšane performanse pretraživanja" umjesto "Poboljšaj performanse pretraživanja"). - **Usvojite perspektivu korisnika:** Pišite za osobu koja koristi vaš softver, a ne za osobu koja je napisala kod. Umjesto da kažete "Refaktoriran optimizator SQL upita", recite "Poboljšane performanse pretraživanja za 50%". Proširenje čak pomaže s mehanikom—automatski ispravlja velika slova u vašim unosima i osigurava da završavaju s odgovarajućom točkom ako to zaboravite. ## Radni prostor bogat značajkama Changelog Template je prepun značajki koje čine dokumentaciju prirodnim dijelom vašeg tijeka rada: ### 1. Brzo kreiranje unosa Kartica "Stvori" je vaša početna točka. Odaberite vrstu promjene, upišite unos i pritisnite "Dodaj u neobjavljeno". Tako je jednostavno. Nema više prebacivanja konteksta između vašeg IDE-a i Markdown datoteke samo da biste zapisali brzu promjenu. ### 2. Trajno upravljanje "neobjavljenim" (Unreleased) Jedna od najmoćnijih značajki dobrog dnevnika promjena je odjeljak "Neobjavljeno". Ovo služi kao prostor za pripremu svih promjena koje ste napravili od zadnje službene verzije. Changelog Template upravlja ovim odjeljkom za vas, pohranjujući vaše unose u lokalnu pohranu tako da su spremni kad god otvorite proširenje. ### 3. Referenca za semantičko verziranje (SemVer) Verziranje ne bi trebalo biti igra pogađanja. Naša kartica "Referenca" uključuje brzi vodič za semantičko verziranje (SemVer), pomažući vam da odlučite treba li vaše sljedeće izdanje biti glavna (Major), sporedna (Minor) ili popravna (Patch) verzija: - **GLAVNA (MAJOR):** Za nekompatibilne promjene API-ja. - **SPOREDNA (MINOR):** Za dodavanje funkcionalnosti na način kompatibilan s prethodnim verzijama. - **POPRAVNA (PATCH):** Za ispravke grešaka kompatibilne s prethodnim verzijama. ### 4. Referenca alata za automatizaciju Za timove spremne za sljedeći korak, pružamo upute za industrijske standarde automatizacije kao što su `standard-version`, `release-it` i `semantic-release`. Ovi alati rade ruku pod ruku s Markdown formatom koji generira naše proširenje kako bi automatizirali cijeli vaš proces izdavanja. ### 5. Kopiranje jednim klikom i izvoz u Markdown Kada ste spremni ažurirati svoju datoteku, možete kopirati odjeljak "Neobjavljeno" kao formatirani Markdown jednim klikom. Trebate li započeti novi projekt? Koristite naš "Potpuni predložak za CHANGELOG.md" za generiranje potpune, gotove datoteke koja uključuje potrebna zaglavlja i poveznice. ## Zašto je dobar dnevnik promjena važan Dobro održavan dnevnik promjena je više od pukog popisa ažuriranja; on je znak zdravog, zrelog projekta. Gradi **transparentnost** pokazujući korisnicima da se projekt aktivno održava. Olakšava **komunikaciju** isticanjem važnih promjena koje bi inače mogle biti zatrpane stotinama poruka o commit-ima. Iznad svega, pokazuje **profesionalizam**. Kada korisnik vidi čist, organiziran CHANGELOG.md, zna da može vjerovati projektu i programeru iza njega. ## Za koga je ovo namijenjeno? - **Solo programeri:** Održavajte svoje sporedne projekte organiziranima i izbjegnite trenutak "što sam ono radio prije tri mjeseca?". - **Mali timovi:** Osigurajte da su svi na istoj stranici u vezi s napretkom projekta bez potrebe za složenim Jira pločama za svako manje ažuriranje. - **Suradnici otvorenog koda:** Učinite svoj projekt privlačnijim novim korisnicima pružanjem jasnih i lako čitljivih napomena o izdanju. ## Jednostavnost korištenja: Bez postavljanja, bez muke Changelog Template je dizajniran da bude nevidljiv dok vam ne zatreba. Nema složenog postavljanja, nema vanjskih računa za kreiranje i nema API ključeva za upravljanje. Koristi lokalnu pohranu preglednika Chrome kako bi vaši podaci ostali privatni i dostupni samo na vašem računalu. Korisničko sučelje je minimalističko i responzivno, savršeno se uklapajući u bočnu traku ili područje skočnog prozora vašeg preglednika. Prestanite dopuštati da vaša projektna dokumentacija zaostaje. Počnite koristiti **Changelog Template** danas i dajte svom softveru profesionalnu povijest kakvu zaslužuje.