Changelog Template

Een software project changelog template die de conventies van Keep a Changelog volgt.

# Changelog Template: De Essentiële Toolkit voor Professionele Projectdocumentatie Het onderhouden van een softwareproject is meer dan alleen code schrijven; het gaat om het communiceren van de evolutie van je werk naar je gebruikers, bijdragers en je toekomstige zelf. Toch wordt de taak om een CHANGELOG.md-bestand bij te werken voor veel ontwikkelaars vaak als een bijzaak beschouwd of volledig vergeten in de drukte van een release. "Changelog Template" is een Chrome-extensie die ontworpen is om deze kloof te overbruggen door een gestroomlijnde, intuïtieve en professionele workflow te bieden voor het onderhouden van hoogwaardige changelogs die voldoen aan de industriestandaard conventies. ## Het Kern Doel: Betere Communicatie via "Keep a Changelog" In de kern is Changelog Template gebouwd om softwareprojecten te helpen zich te houden aan de "Keep a Changelog"-conventies. Een goede changelog is een gecureerde, chronologisch geordende lijst van opvallende wijzigingen voor elke versie van een project. Het is geen ruwe dump van git-commits; het is een document geschreven voor mensen. Door deze extensie te gebruiken, zorg je ervoor dat de geschiedenis van je project leesbaar, georganiseerd en nuttig is. Of je nu een klein zijproject, een grote open-source bibliotheek of een reeks interne tools beheert, Changelog Template biedt de structuur die je nodig hebt om transparantie en professionaliteit te behouden zonder frictie toe te voegen aan je ontwikkelingscyclus. ## Een Gestandaardiseerd Formaat Dat Je Kunt Vertrouwen De extensie is strikt afgestemd op het standaard changelog-formaat, wat ervoor zorgt dat je documentatie er professioneel uitziet en compatibel blijft met het bredere ecosysteem. Elke vermelding die je maakt, wordt gecategoriseerd in een van de zes standaard wijzigingstypes aanbevolen door het "Keep a Changelog"-project: 1. **Added:** Voor nieuwe functies die de mogelijkheden van je software uitbreiden. 2. **Changed:** Voor wijzigingen in bestaande functionaliteit die de werking veranderen. 3. **Deprecated:** Voor functies die binnenkort worden verwijderd, om gebruikers te waarschuwen om te migreren. 4. **Removed:** Voor functies die officieel uit de codebase zijn verwijderd. 5. **Fixed:** Voor bugfixes die problemen oplossen en de stabiliteit verbeteren. 6. **Security:** Voor kritieke patches die kwetsbaarheden aanpakken. Deze categorisering helpt gebruikers om snel je release-notes te scannen om precies te vinden wat ze nodig hebben, of ze nu op zoek zijn naar nieuwe tools of willen controleren of een specifieke bug is opgelost. ## Richtlijnen voor het Schrijven van Impactvolle Vermeldingen Het schrijven van een goede changelog-vermelding is een kunst. Het vereist een balans tussen technische nauwkeurigheid en toegankelijkheid. Changelog Template geeft je niet alleen een tekstvak; het biedt de context en begeleiding die nodig is om vermeldingen te schrijven die ertoe doen. Wij pleiten voor drie eenvoudige regels: - **Gebruik enkele zinnen:** Houd het beknopt. Eén duidelijk punt per vermelding is beter dan een dichte alinea. - **Gebruik de verleden tijd:** Je beschrijft wat *is veranderd* (bijv. "Zoekprestaties verbeterd" in plaats van "Zoekprestaties verbeteren"). - **Neem een gebruikersperspectief aan:** Schrijf voor de persoon die je software gebruikt, niet voor de persoon die de code heeft geschreven. In plaats van "SQL-query-optimalisatie geherstructureerd," zeg "Zoekprestaties met 50% verbeterd." De extensie helpt zelfs bij de details—door automatisch je vermeldingen met een hoofdletter te beginnen en ervoor te zorgen dat ze eindigen met een punt als je dat vergeet. ## Functierijke Werkruimte Changelog Template zit boordevol functies die documentatie als een natuurlijk onderdeel van je workflow laten voelen: ### 1. Snelle Creatie van Vermeldingen Het "Create"-tabblad is je landingszone. Selecteer je wijzigingstype, typ je vermelding en klik op "Add to Unreleased." Zo simpel is het. Niet meer schakelen tussen je IDE en een Markdown-bestand om even snel een update te noteren. ### 2. Persistent "Unreleased" Beheer Een van de krachtigste functies van een goede changelog is de "Unreleased"-sectie. Dit fungeert als een wachtruimte voor alle wijzigingen die je hebt gemaakt sinds de laatste officiële versie. Changelog Template beheert deze sectie voor je en houdt je vermeldingen in de lokale opslag, zodat ze klaar zijn wanneer je de extensie opent. ### 3. Referentie voor Semantische Versiebeheer (SemVer) Versiebeheer zou geen gokspel moeten zijn. Ons "Reference"-tabblad bevat een snelstartgids voor Semantisch Versiebeheer (SemVer), die je helpt te beslissen of je volgende release een Major-, Minor- of Patch-versie moet zijn: - **MAJOR:** Voor incompatibele API-wijzigingen. - **MINOR:** Voor het toevoegen van functionaliteit op een achterwaarts compatibele manier. - **PATCH:** Voor achterwaarts compatibele bugfixes. ### 4. Referentie voor Automatiseringstools Voor teams die klaar zijn voor de volgende stap, bieden we verwijzingen naar industriestandaard automatiseringstools zoals `standard-version`, `release-it` en `semantic-release`. Deze tools werken hand in hand met het Markdown-formaat dat door onze extensie wordt gegenereerd om je gehele releaseproces te automatiseren. ### 5. Kopiëren met één klik & Markdown-export Zodra je klaar bent om je bestand bij te werken, kun je de "Unreleased"-sectie kopiëren als geformatteerde Markdown met één klik. Moet je een nieuw project starten? Gebruik ons "Full CHANGELOG.md Starter Template" om een compleet boilerplate-bestand te genereren dat de nodige headers en links bevat. ## Waarom een goede Changelog belangrijk is Een goed onderhouden changelog is meer dan alleen een lijst met updates; het is een teken van een gezond, volwassen project. Het bouwt **transparantie** op door aan gebruikers te laten zien dat het project actief wordt onderhouden. Het faciliteert **communicatie** door belangrijke wijzigingen te benadrukken die anders begraven zouden kunnen zijn in honderden commit-berichten. Bovenal toont het **professionaliteit**. Wanneer een gebruiker een schone, georganiseerde CHANGELOG.md ziet, weten ze dat ze het project en de ontwikkelaar erachter kunnen vertrouwen. ## Voor wie is dit bedoeld? - **Solo-ontwikkelaars:** Houd je zijprojecten georganiseerd en vermijd het "wat heb ik drie maanden geleden gedaan?"-moment. - **Kleine teams:** Zorg ervoor dat iedereen op één lijn zit wat betreft de voortgang van het project zonder complexe Jira-borden voor elke kleine update. - **Open-source bijdragers:** Maak je project uitnodigender voor nieuwe gebruikers door duidelijke, gemakkelijk leesbare release-notes te bieden. ## Gebruiksgemak: Geen Setup, Geen Gedoe Changelog Template is ontworpen om onzichtbaar te zijn totdat je het nodig hebt. Er is geen complexe setup, geen externe accounts om aan te maken en geen API-sleutels om te beheren. Het gebruikt de lokale opslag van Chrome om je gegevens privé te houden en alleen toegankelijk op je eigen machine. De UI is minimalistisch en responsief, en past perfect in de zijbalk of het popup-gebied van je browser. Laat je projectdocumentatie niet achterblijven. Begin vandaag nog met het gebruiken van **Changelog Template** en geef je software de professionele geschiedenis die het verdient.