Glossario · ThinkClouds

Changelog

Elenco ordinato delle modifiche di un software, versione per versione, scritto per chi deve decidere se e come aggiornare.

Il changelog, o registro delle modifiche, è l’elenco ordinato dei cambiamenti di un software, versione per versione, dalla più recente alla più vecchia. Ogni voce indica il numero di versione, la data e che cosa è cambiato: funzioni aggiunte, comportamenti modificati, errori corretti, funzioni rimosse, problemi di sicurezza risolti.

Per chi è scritto

Un changelog utile è scritto per chi usa il software, non per chi lo sviluppa. Lo storico dei commit di un progetto dice che cosa ha fatto lo sviluppatore; il changelog dice che cosa cambia per l’utente. La proposta più diffusa su come scriverlo, il progetto Keep a Changelog, raccomanda di raggruppare le modifiche per tipo (aggiunto, modificato, deprecato, rimosso, corretto, sicurezza), di datare ogni versione e di tenere una sezione per le modifiche non ancora rilasciate.

Perché conta

Chi gestisce molti siti decide ogni giorno se aggiornare e quando. Un changelog chiaro risponde alle domande che servono: questa versione corregge il problema che ho visto? cambia qualcosa che devo verificare? richiede un’azione da parte mia? Quando un aggiornamento rompe qualcosa, il changelog è il primo posto in cui cercare la causa. Nei plugin WordPress il changelog sta nel file readme.txt e compare nella scheda del plugin.

Nei plugin ThinkClouds

Ogni scheda del catalogo su thinkclouds.com ha una sezione “Novità per versione”, con data e modifiche raggruppate per tipo, e in ThinkRepo il changelog viaggia insieme alla release. Molte voci sono correzioni nate durante gli audit dei siti, ed è per questo che la procedura di audit chiede di rileggere le pagine dei plugin prima di usarli: le funzioni descritte nella documentazione di un mese prima possono essere già cambiate. Le voci segnalano anche gli avvisi dei controlli automatici, come la revisione dello standard ThinkClouds rispetto a cui il plugin è stato verificato.

Fonti

Serve aiuto?

Installiamo, configuriamo e colleghiamo il plugin al tuo sito, con i template Elementor già pronti.