Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Writing the migration guide for Kivy 2.3.0 apps to 3.0.0 #8585

Open
misl6 opened this issue Jan 21, 2024 · 0 comments
Open

Writing the migration guide for Kivy 2.3.0 apps to 3.0.0 #8585

misl6 opened this issue Jan 21, 2024 · 0 comments
Milestone

Comments

@misl6
Copy link
Member

misl6 commented Jan 21, 2024

Writing a migration guide for porting Kivy 2.3.0 apps to 3.0.0 could be an enormous amount of work to do if done on a single shot.

Instead, when making changes via PRs that will impact 2.x.x features, is the author's responsibility (with maintainer help) to keep a list of the things that have been removed/moved/changed and to write migration suggestions and guide.

Every time a new PR is ready to be merged:

  • Check if any breaking change has been made
  • If a breaking change has been made, add a new point to MIGRATION-2.3.x_to_3.0.0.md, explain what has been changed, and suggest a migration path
  • Discuss it with the PR reviewer, and improve it
  • Ping a maintainer, and get it approved

At the end of the 3.0.0 milestone, and before the release:

  • Review MIGRATION-2.3.x_to_3.0.0.md, and add relevant warnings on docs.
  • Include MIGRATION-2.3.x_to_3.0.0.md in docs.
@misl6 misl6 added this to the 3.0.0 milestone Jan 21, 2024
@misl6 misl6 pinned this issue Jan 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

No branches or pull requests

1 participant