Documentazione breaking changes

[alessaro92]

Esiste già una discussione sul tema che ti interessa, o su un tema simile?

• Ho verificato e non esiste

Versione della libreria

2.11

Cosa

Manca una sezione specifica riguardante le breaking changes tra minor versions, o almeno non sono riuscito a trovarla.
Nel mio caso ho aggiornato da 2.x a 2.11 o successiva e sono incappato in questa breaking change che ho scoperto soltanto cercando lo specifico componente dopo essermi accorto era diverso rispetto a prima:
https://italia.github.io/bootstrap-italia/docs/organizzare-i-contenuti/liste/#con-testo-aggiuntivo-azioni-multiple-e-metadata

Sarebbe utile avere una pagina ad hoc per le breaking changes come c'è per la migrazione dalla versione 1.x

Perché

Utile per supportare al meglio gli sviluppatori durante gli aggiornamenti di versioni minor della libreria

Contesto

No response

Altro

No response

[zetareticoli]

Attualmente le breaking changes sono documentate nelle varie sotto sezioni specifiche e nel changelog (esempio).

Ti immaginavi una sezione equivalente del changelod di GitHub o una lista delle solite breaking raccolte per versione?

[alessaro92]

La mia idea era una sezione con la raccolta di breaking changes per versione ed eventuali riferimenti specifici, in modo da semplificare le migrazioni alle nuove versioni. Nell'esempio che ho riportato sopra https://italia.github.io/bootstrap-italia/docs/organizzare-i-contenuti/liste/#con-testo-aggiuntivo-azioni-multiple-e-metadata è indicata una breaking change a partire dalla versione 2.11 ma non è indicata come tale nel changelog di github