🚀 Feature: MIGRATION.md aktualisieren

[Chrisdo82]

Goals

Non-Goals

Background

Bei einer neuen Major Version wäre es schön, wenn man wie bei anderen Libs auch sofort weiß, welche Dinge "kaputt" gegangen sind und daher angepasst werden müssen. Ich weiß aus eigener Erfahrung dass das viel Aufwand ist, der für die Nutzenden aber unglaublich wichtig ist und einem viel Arbeit erspart.

Durch die Release Notes kann man das nur indirekt mit viel Fantasie rauslesen.

Proposal

Die vorhandene MIGRATION.md sollte stets aktuell gehalten werden. Außerdem sollte der Inhalt detailliert sein und dem Entwickler der die Umstellung macht auch weiterhelfen, dazu gehören auch vorher/nachher Code Beispiele.

Das Ziel sollte sein, das keine Fragen offen bleiben.

Tailwind bietet z.B. eine sehr detaillierte Migrationsanleitung an: https://tailwindcss.com/docs/upgrade-guide

[deleonio]

Hi @Chrisdo82,

danke für den Hinweis. In unserem Repo gibt es entsprechende Markdown-Files für die Migration auf Deutsch und English. Diese verlinken dann auch auf die BREAKING-CHANGES bei den Major-Releases.

Die Anleitung auf unserer Website müssen wir hier offensichtlich optimieren, damit man die passenden Markdown-Docs findet.

[deleonio]

Ticket #8436