Plantilla del registre de canvis

Una plantilla de registre de canvis de projectes de programari que segueix les convencions de Keep a Changelog.

# Plantilla de registre de canvis: El kit d'eines essencial per a la documentació professional de projectes El manteniment d'un projecte de programari va més enllà de l'escriptura de codi; es tracta de comunicar l'evolució de la teva feina als teus usuaris, col·laboradors i al teu jo del futur. Tanmateix, per a molts desenvolupadors, la tasca d'actualitzar un fitxer CHANGELOG.md sovint es relega a un segon pla o s'oblida completament durant la pressió d'un llançament. "Changelog Template" és una extensió de Chrome dissenyada per salvar aquesta bretxa, oferint un flux de treball racionalitzat, intuïtiu i professional per mantenir registres de canvis d'alta qualitat que segueixin les convencions estàndard de la indústria. ## El propòsit principal: Millor comunicació a través de "Keep a Changelog" En el seu nucli, Changelog Template està dissenyat per ajudar els projectes de programari a adherir-se a les convencions de "Keep a Changelog". Un bon registre de canvis és una llista curada i ordenada cronològicament de canvis notables per a cada versió d'un projecte. No és un bolcat brut de commits de git; és un document escrit per a humans. Utilitzant aquesta extensió, garanteixes que l'historial del teu projecte sigui llegible, organitzat i útil. Tant si gestiones un petit projecte paral·lel, una gran biblioteca de codi obert o un conjunt d'eines internes, Changelog Template proporciona l'estructura que necessites per mantenir la transparència i la professionalitat sense afegir fricció al teu cicle de desenvolupament. ## Un format estandarditzat en què pots confiar L'extensió està estrictament alineada amb el format estàndard de registre de canvis, assegurant que la teva documentació sembli professional i romangui compatible amb l'ecosistema més ampli. Cada entrada que crees es classifica en un dels sis tipus de canvi estàndard recomanats pel projecte "Keep a Changelog": 1. **Afegit:** Per a noves funcionalitats que amplien les capacitats del teu programari. 2. **Canviat:** Per a canvis en la funcionalitat existent que alteren com funcionen les coses. 3. **Desaprovat:** Per a funcionalitats que s'eliminaran aviat, avisant els usuaris perquè migrin. 4. **Eliminat:** Per a funcionalitats que s'han retirat oficialment de la base de codi. 5. **Corregit:** Per a qualsevol correcció d'errors que resolgui problemes i millori l'estabilitat. 6. **Seguretat:** Per a pegats crítics que aborden vulnerabilitats. Aquesta categorització ajuda els usuaris a escanejar ràpidament les teves notes de llançament per trobar exactament el que necessiten, tant si busquen noves eines per utilitzar com si comproven si s'ha corregit un error específic. ## Guia per escriure entrades impactants Escriure una bona entrada de registre de canvis és una forma d'art. Requereix equilibrar la precisió tècnica amb l'accessibilitat. Changelog Template no només et dóna un quadre de text; proporciona el context i la guia necessaris per escriure entrades que importin. Advocarem per tres regles senzilles: - **Utilitza frases simples:** Sigues concís. Un punt clar per entrada és millor que un paràgraf dens. - **Utilitza el passat:** Estàs descrivint el que *ha canviat* (p. ex., "Millorat el rendiment de la cerca" en lloc de "Millorar el rendiment de la cerca"). - **Adopta la perspectiva de l'usuari:** Escriu per a la persona que utilitza el teu programari, no per a la persona que va escriure el codi. En lloc de dir "Refactoritzat l'optimitzador de consultes SQL", digues "Millorat el rendiment de la cerca en un 50%". L'extensió fins i tot ajuda amb la mecànica: posa automàticament en majúscules les teves entrades i s'assegura que acabin amb un punt final adequat si t'oblides. ## Espai de treball ric en funcions Changelog Template està ple de funcions que fan que la documentació se senti com una part natural del teu flux de treball: ### 1. Creació ràpida d'entrades La pestanya "Crear" és la teva zona d'aterratge. Selecciona el teu tipus de canvi, escriu la teva entrada i prem "Afegeix a No publicat". És així de senzill. No més canvis de context entre el teu IDE i un fitxer Markdown només per apuntar una actualització ràpida. ### 2. Gestió persistent de "No publicat" Una de les funcions més potents d'un bon registre de canvis és la secció "No publicat". Això actua com una àrea d'espera per a tots els canvis que has fet des de l'última versió oficial. Changelog Template gestiona aquesta secció per tu, mantenint les teves entrades a l'emmagatzematge local perquè estiguin llestes sempre que obris l'extensió. ### 3. Referència al Versionat Semàntic (SemVer) El versionat no hauria de ser un joc d'endevinalles. La nostra pestanya "Referència" inclou una guia d'inici ràpid sobre el Versionat Semàntic (SemVer), ajudant-te a decidir si el teu proper llançament hauria de ser una versió Major, Minor o Patch: - **MAJOR:** Per a canvis incompatibles a l'API. - **MINOR:** Per afegir funcionalitat de manera compatible cap enrere. - **PATCH:** Per a correccions d'errors compatibles cap enrere. ### 4. Referència d'eines d'automatització Per als equips a punt per fer el següent pas, oferim punts d'accés a eines d'automatització estàndard de la indústria com `standard-version`, `release-it` i `semantic-release`. Aquestes eines funcionen colze a colze amb el format Markdown generat per la nostra extensió per automatitzar tot el teu procés de llançament. ### 5. Còpia amb un clic i exportació Markdown Un cop estiguis llest per actualitzar el teu fitxer, pots copiar la secció "No publicat" com a Markdown formatat amb un sol clic. Necessites començar un projecte nou? Utilitza la nostra "Plantilla d'inici completa CHANGELOG.md" per generar un fitxer complet i plantilla que inclogui les capçaleres i els enllaços necessaris. ## Per què un bon registre de canvis importa Un registre de canvis ben mantingut és més que una simple llista d'actualitzacions; és un signe d'un projecte saludable i madur. Construeix **transparència** mostrant als usuaris que el projecte està activament mantingut. Facilita la **comunicació** destacant canvis importants que d'altra manera podrien quedar enterrats en centenars de missatges de commit. Per sobre de tot, demostra **professionalitat**. Quan un usuari veu un CHANGELOG.md net i organitzat, sap que pot confiar en el projecte i en el desenvolupador que hi ha al darrere. ## Per a qui és això? - **Desenvolupadors en solitari:** Mantén els teus projectes paral·lels organitzats i evita el moment "què vaig fer fa tres mesos?". - **Equips petits:** Assegura't que tothom estigui en sintonia pel que fa al progrés del projecte sense necessitar taulers Jira complexos per a cada actualització menor. - **Col·laboradors de codi obert:** Fes el teu projecte més atractiu per als nous usuaris proporcionant notes de llançament clares i fàcils de llegir. ## Facilitat d'ús: Sense configuració, sense molèsties Changelog Template està dissenyat per ser invisible fins que el necessites. No hi ha cap configuració complexa, ni comptes externs a crear, ni claus d'API a gestionar. Utilitza l'emmagatzematge local de Chrome per mantenir les teves dades privades i accessibles només a la teva màquina. La interfície d'usuari és minimalista i sensible, encaixant perfectament a la barra lateral o a l'àrea emergent del teu navegador. Deixa de permetre que la documentació del teu projecte es quedi enrere. Comença a utilitzar **Changelog Template** avui mateix i dóna al teu programari l'historial professional que es mereix.