Changelog mal

Eit programvareprosjekt sitt changelog mal som fylgjer Keep a Changelog konvensjonar.

# Mal-mal: Den essensielle verktøykassen for profesjonell prosjektdokumentasjon Å vedlikeholde et programvareprosjekt handler om mer enn bare å skrive kode; det handler om å kommunisere utviklingen av arbeidet ditt til brukere, bidragsytere og ditt fremtidige jeg. Likevel blir oppgaven med å oppdatere en CHANGELOG.md-fil ofte nedprioritert eller glemt i stresset rundt en utgivelse. "Changelog Template" er en Chrome-utvidelse designet for å tette dette gapet ved å tilby en strømlinjeformet, intuitiv og profesjonell arbeidsflyt for vedlikehold av changelogs av høy kvalitet som følger industristandarder. ## Kjernepurposet: Bedre kommunikasjon gjennom "Keep a Changelog" I bunn og grunn er Changelog Template bygget for å hjelpe programvareprosjekter med å følge "Keep a Changelog"-konvensjonene. En god changelog er en kuratert, kronologisk ordnet liste over bemerkelsesverdige endringer for hver versjon av et prosjekt. Det er ikke en rådump av git-commits; det er et dokument skrevet for mennesker. Ved å bruke denne utvidelsen sikrer du at prosjektets historikk er lesbar, organisert og nyttig. Enten du administrerer et lite sideprosjekt, et stort åpen kildekode-bibliotek eller en pakke med interne verktøy, gir Changelog Template strukturen du trenger for å opprettholde åpenhet og profesjonalitet uten å skape friksjon i utviklingssyklusen. ## Et standardisert format du kan stole på Utvidelsen er strengt tilpasset standard changelog-format, noe som sikrer at dokumentasjonen din ser profesjonell ut og forblir kompatibel med det bredere økosystemet. Hver oppføring du oppretter kategoriseres i en av de seks standard endringstypene anbefalt av "Keep a Changelog"-prosjektet: 1. **Added:** For nye funksjoner som utvider funksjonaliteten i programvaren din. 2. **Changed:** For endringer i eksisterende funksjonalitet som endrer hvordan ting fungerer. 3. **Deprecated:** For funksjoner som snart vil bli fjernet, slik at brukere får beskjed om å migrere. 4. **Removed:** For funksjoner som offisielt er fjernet fra kodebasen. 5. **Fixed:** For alle feilrettinger som løser problemer og forbedrer stabiliteten. 6. **Security:** For kritiske oppdateringer som adresserer sårbarheter. Denne kategoriseringen hjelper brukere med å raskt skanne utgivelsesnotatene dine for å finne akkurat det de trenger, enten de leter etter nye verktøy å bruke eller sjekker om en spesifikk feil er rettet. ## Veiledning for å skrive slagkraftige oppføringer Å skrive en god changelog-oppføring er en kunst. Det krever balanse mellom teknisk nøyaktighet og tilgjengelighet. Changelog Template gir deg ikke bare en tekstboks; den gir konteksten og veiledningen som trengs for å skrive oppføringer som betyr noe. Vi foreslår tre enkle regler: - **Bruk enkelte setninger:** Vær kortfattet. Ett tydelig poeng per oppføring er bedre enn et tett avsnitt. - **Bruk fortid:** Du beskriver hva *som har endret seg* (f.eks. "Forbedret søkeytelse" i stedet for "Forbedre søkeytelse"). - **Adopter et brukerperspektiv:** Skriv for personen som bruker programvaren din, ikke personen som skrev koden. I stedet for å si "Refaktorerte SQL-spørringsoptimaliseringen", si "Forbedret søkeytelse med 50 %." Utvidelsen hjelper til og med med det mekaniske—den automatiserer store forbokstaver i oppføringene dine og sikrer at de slutter med et punktum hvis du glemmer det. ## Funksjonsrikt arbeidsområde Changelog Template er pakket med funksjoner som gjør dokumentasjon til en naturlig del av arbeidsflyten din: ### 1. Rask opprettelse av oppføringer "Create"-fanen er startpunktet ditt. Velg endringstype, skriv inn oppføringen din, og trykk "Add to Unreleased". Det er så enkelt. Ingen mer kontekstbytte mellom IDE-en din og en Markdown-fil bare for å skrive ned en rask oppdatering. ### 2. Vedvarende "Unreleased"-håndtering En av de kraftigste funksjonene i en god changelog er "Unreleased"-delen. Dette fungerer som et mellomlager for alle endringene du har gjort siden forrige offisielle versjon. Changelog Template administrerer denne delen for deg ved å lagre oppføringene i lokal lagring, slik at de er klare når du åpner utvidelsen. ### 3. Referanse for semantisk versjonering (SemVer) Versjonering bør ikke være gjettelek. Vår "Reference"-fane inneholder en hurtigstartguide til semantisk versjonering (SemVer), som hjelper deg med å avgjøre om din neste utgivelse skal være en Major, Minor eller Patch-versjon: - **MAJOR:** For inkompatible API-endringer. - **MINOR:** For å legge til funksjonalitet på en bakoverkompatibel måte. - **PATCH:** For bakoverkompatible feilrettinger. ### 4. Referanse for automatiseringsverktøy For team som er klare for neste steg, gir vi tips til industristandard automatiseringsverktøy som `standard-version`, `release-it` og `semantic-release`. Disse verktøyene fungerer hånd i hånd med Markdown-formatet generert av utvidelsen vår for å automatisere hele utgivelsesprosessen. ### 5. Ett-klikks kopiering og Markdown-eksport Når du er klar til å oppdatere filen din, kan du kopiere "Unreleased"-delen som formatert Markdown med ett klikk. Trenger du å starte et nytt prosjekt? Bruk vår "Full CHANGELOG.md Starter Template" for å generere en komplett malfil som inkluderer nødvendige overskrifter og lenker. ## Hvorfor en god changelog betyr noe En godt vedlikeholdt changelog er mer enn bare en liste over oppdateringer; det er et tegn på et sunt, modent prosjekt. Den bygger **åpenhet** ved å vise brukere at prosjektet aktivt vedlikeholdes. Den legger til rette for **kommunikasjon** ved å fremheve viktige endringer som ellers kunne blitt begravd i hundrevis av commit-meldinger. Fremfor alt viser den **profesjonalitet**. Når en bruker ser en ren, organisert CHANGELOG.md, vet de at de kan stole på prosjektet og utvikleren bak det. ## Hvem er dette for? - **Solo-utviklere:** Hold sideprosjektene dine organiserte og unngå "hva gjorde jeg for tre måneder siden?"-øyeblikket. - **Små team:** Sørg for at alle er på samme side angående prosjektfremgang uten behov for komplekse Jira-brett for hver lille oppdatering. - **Bidragsytere til åpen kildekode:** Gjør prosjektet ditt mer inviterende for nye brukere ved å tilby klare, lettleste utgivelsesnotater. ## Brukervennlighet: Ingen oppsett, ikke noe stress Changelog Template er designet for å være usynlig til du trenger den. Det er ingen komplekse oppsett, ingen eksterne kontoer å opprette, og ingen API-nøkler å administrere. Den bruker Chromes lokale lagring for å holde dataene dine private og kun tilgjengelige på maskinen din. Brukergrensesnittet er minimalistisk og responsivt, og passer perfekt inn i nettleserens sidefelt eller popup-område. Ikke la prosjektdokumentasjonen din henge etter. Begynn å bruke **Changelog Template** i dag og gi programvaren din den profesjonelle historikken den fortjener.