mui / mui/material-ui

[migration] Provide migration guide/codemods for migrating from v4 to v6

Open
#42,676 0 comments 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

package: codemod scope: all components v4.x v6.x migration waiting for 👍
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Summary

This issue is created in order to get traction of the need for providing a migration guide and/or codemods for upgrading from v4 to v6 directly. Currently around one-quarter of the downloads come from v4, however it is not clear how big a percentage of these downloads comes from projects that are never going to be migrated, planned to be migrated, or are currently being migrated v5.

I would ask anyone who is on v4 and who is looking into migrating to v6 to upvote the issue, based on the interest we may spend some time to help and provide clearer guidance or codemods to make this easier.

Motivation

The v4 to v5 migration was reported as a very hard upgrade. If we can avoid having people to migrate to v5, just so that they can get v6, it would be great.

Search keywords: migration, v4, v6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by determining whether the deliverable is a v4-to-v6 migration guide, codemods, or both, then identify the v4-to-v6 breaking changes that need coverage. Done means users can follow the guidance or run the codemods to migrate directly from v4 to v6.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.