[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [theia-dev] Handling breaking changes
|
If you are have trouble when upgrading your application to a newer version of Theia, have a look at "doc/Migration.md". Someone else might have had the same trouble before and found a solution.
If you are the first to run into a particular problem, please open a pull request against "doc/Migration.md" and describe the work you had to do to upgrade. Sharing is caring ;-). Your peers will be thankful.
If you wonder how the migration guide relates to CHANGLOG.md: the changelog tells you what has changed in a short manner. The migration guide tells you what you need to do to fix your Theia application, build, etc. The responsibility for writing a changelog entry clearly falls upon the author of the PR introducing a breaking change. Reviewers should not approve breaking changes without a change log entry. Many times, the changelog entry is sufficient for adopters, e.g. "deprecated Foo, use Bar instead". But if that is not the case, the author of a change should add an entry to the migration guide. Since adopters override different parts of Theia and because the applications we build are different, the change author might not be able to provide upgrade guidance for every case. In that case, the community members are called upon to share their knowledge in the migration guide.
/Thomas
------ Original Message ------
From: "Thomas Mäder" <tmader@xxxxxxxxxx>
To: "theia developer discussions" <theia-dev@xxxxxxxxxxx>
Sent: 28/07/2021 10:32:35
Subject: Handling breaking changes
Hi folks,
following up on yesterday's discussion in the Theia community meeting, I've filed https://github.com/eclipse-theia/theia/issues/9787, Please chime in on the issue with any suggestions, corrections, etc.
/Thomas
