Predložak zapisnika promjena

Predložak zapisnika promjena softverskog projekta koji slijedi konvencije Keep a Changelog.

# Predložak promjena: Osnovni alat za profesionalnu dokumentaciju projekta Održavanje softverskog projekta podrazumijeva više od samog pisanja koda; radi se o komuniciranju evolucije vašeg rada vašim korisnicima, suradnicima i budućoj verziji vas samih. Ipak, za mnoge programere, zadatak ažuriranja datoteke CHANGELOG.md često ostaje u drugom planu ili se potpuno zaboravi u žurbi oko objavljivanja. "Changelog Template" je Chrome proširenje dizajnirano da premosti taj jaz, pružajući jednostavan, intuitivan i profesionalan tijek rada za održavanje visokokvalitetnih popisa promjena koje slijede industrijske standarde. ## Osnovna svrha: Bolja komunikacija kroz "Keep a Changelog" U svojoj srži, Changelog Template je napravljen kako bi pomogao softverskim projektima da se pridržavaju konvencija "Keep a Changelog". Dobar popis promjena (changelog) je kurirani, kronološki poredan popis značajnih izmjena za svaku verziju projekta. To nije sirovi ispis git commit-ova; to je dokument pisan za ljude. Korištenjem ovog proširenja osiguravate da je povijest vašeg projekta č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 trenja vašem razvojnom ciklusu. ## Standardizirani format kojem možete vjerovati Proširenje je strogo usklađeno sa standardnim formatom popisa promjena, osiguravajući da vaša dokumentacija izgleda profesionalno i ostane kompatibilna sa širim ekosustavom. Svaki unos koji stvorite 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 na koji stvari rade. 3. **Zastarjelo (Deprecated):** Za značajke koje će uskoro biti uklonjene, upozoravajući korisnike da migriraju. 4. **Uklonjeno (Removed):** Za značajke koje su službeno uklonjene iz kodne baze. 5. **Popravljeno (Fixed):** Za sve popravke bugova koji rješavaju probleme i poboljšavaju stabilnost. 6. **Sigurnost (Security):** Za kritične zakrpe koje adresiraju ranjivosti. Ova kategorizacija pomaže korisnicima da brzo pregledaju vaše bilješke o izdanju i pronađu upravo ono što im treba, bilo da traže nove alate za korištenje ili provjeravaju je li određeni bug ispravljen. ## Upute za pisanje utjecajnih unosa Pisanje dobrog unosa u popis promjena je umjetnost. Zahtijeva ravnotežu između 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. Zagovaramo tri jednostavna pravila: - **Koristite jednostavne rečenice:** Budite sažeti. Jedna jasna poanta po unosu bolja je od gustog odlomka. - **Koristite prošlo vrijeme:** Opisujete ono *što se promijenilo* (npr. "Poboljšana izvedba pretraživanja" umjesto "Poboljšati izvedbu pretraživanja"). - **Usvojite perspektivu korisnika:** Pišite za osobu koja koristi vaš softver, a ne za osobu koja je napisala kod. Umjesto "Refaktoriran optimizator SQL upita", recite "Poboljšana izvedba pretraživanja za 50%." Proširenje čak pomaže i kod mehanike—automatski kapitalizira vaše unose i osigurava da završavaju ispravnom točkom ako zaboravite. ## Radni prostor bogat značajkama Changelog Template je prepun značajki koje čine dokumentaciju prirodnim dijelom vašeg tijeka rada: ### 1. Brzo stvaranje unosa Kartica "Create" je vaša početna točka. Odaberite vrstu promjene, upišite svoj unos i pritisnite "Add to Unreleased". Tako je jednostavno. Nema više prebacivanja konteksta između vašeg IDE-a i Markdown datoteke samo kako biste zapisali brzo ažuriranje. ### 2. Upravljanje sekcijom "Unreleased" Jedna od najmoćnijih značajki dobrog popisa promjena je sekcija "Unreleased". Ona služi kao područje za pripremu svih promjena koje ste napravili od posljednje službene verzije. Changelog Template upravlja ovom sekcijom umjesto vas, pohranjujući vaše unose u lokalnu pohranu tako da su spremni kad god otvorite proširenje. ### 3. Referenca semantičkog verziranja (SemVer) Verziranje ne bi trebalo biti igra pogađanja. Naša kartica "Reference" uključuje brzi vodič za semantičko verziranje (SemVer), pomažući vam da odlučite hoće li vaše sljedeće izdanje biti Major, Minor ili Patch verzija: - **MAJOR:** Za nekompatibilne promjene API-ja. - **MINOR:** Za dodavanje funkcionalnosti na način kompatibilan s prethodnim verzijama. - **PATCH:** Za popravke bugova kompatibilne s prethodnim verzijama. ### 4. Referenca alata za automatizaciju Za timove spremne na sljedeći korak, pružamo upute za industrijske standardne alate za automatizaciju 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 Markdown izvoz Kada budete spremni ažurirati svoju datoteku, možete kopirati sekciju "Unreleased" kao formatirani Markdown jednim klikom. Trebate li započeti novi projekt? Koristite naš "Full CHANGELOG.md Starter Template" za generiranje potpune, gotove datoteke koja uključuje potrebna zaglavlja i poveznice. ## Zašto je dobar popis promjena važan Dobro održavan popis promjena je više od pukog popisa ažuriranja; to 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 zakopane u stotinama poruka commit-a. Iznad svega, pokazuje **profesionalizam**. Kada korisnik vidi čist, organiziran CHANGELOG.md, zna da može vjerovati projektu i programeru koji stoji 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 pogledu napretka projekta bez potrebe za složenim Jira pločama za svako malo ažuriranje. - **Suradnici na otvorenom kodu:** Učinite svoj projekt privlačnijim novim korisnicima pružanjem jasnih i lako čitljivih bilješki o izdanju. ## Jednostavnost upotrebe: Bez postavljanja, bez muke Changelog Template je dizajniran da bude nevidljiv dok vam ne zatreba. Nema složenog postavljanja, nema vanjskih računa za stvaranje 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 stroju. Korisničko sučelje je minimalističko i responzivno, savršeno se uklapa u bočnu traku ili područje skočnog prozora vašeg preglednika. Prestanite dopuštati da vaša dokumentacija projekta zaostaje. Počnite koristiti **Changelog Template** danas i dajte svom softveru profesionalnu povijest kakvu zaslužuje.