[docs][material-next] Add contributing guide #39944
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Netlify deploy previewhttps://deploy-preview-39944--material-ui.netlify.app/ Bundle size report |
mj12albert
commented
Nov 21, 2023
| @@ -13,3 +13,10 @@ Material UI v6's notable changes compared to v5 are: | |||
| - Implement [Material You](https://m3.material.io/) (Material Design 3). | |||
|
|
|||
| For migration steps when upgrading from v5, follow the [migration guide](/packages/mui-material-next/migration.md). | |||
|
|
|||
| ## Contributing | |||
There was a problem hiding this comment.
Copy-pasta from mui-base/README.md 😬
mnajdova
reviewed
Nov 21, 2023
| 4. Drop support for `ThemeProvider` in favor of `CssVarsProvider`. In practice, this means: | ||
| - Consuming tokens from `theme.vars` instead of `theme` | ||
| - In tests, using `CssVarsProvider` and `extendTheme` (both imported from `@mui/material-next/styles`) instead of `ThemeProvider` and `createTheme`, as well as providing the same `CssVarsProvier` and `extendTheme` to `describeConformance`'s `ThemeProvider` and `createTheme` options. | ||
| 5. Refactor component to use Base UI hooks if it exists |
There was a problem hiding this comment.
Suggested change
| 5. Refactor component to use Base UI hooks if it exists |
We can drop this, it can be added later, especially if we aim at releasing only Material You as a change in v6 without other unexpected breaking changes
mnajdova
reviewed
Nov 21, 2023
| - Try to avoid breaking changes, keeping the component’s API the same: | ||
| - An exception to this is to use Material You nomenclature and naming conventions, even if it would be a breaking change. | ||
| - If breaking changes are inevitable, then document them right away in `/packages/mui-material-next/migration.md` and add the `breaking change` label to your PR. | ||
| - Divide the work in whatever way makes more sense. One PR for all steps, one PR for each step, or anything in between |
There was a problem hiding this comment.
Suggested change
| - Divide the work in whatever way makes more sense. One PR for all steps, one PR for each step, or anything in between | |
| - Divide the work in whatever way makes more sense. One PR for few steps or one PR for each step, however keep in mind that smaller pull request will be reviewed faster |
DiegoAndai
reviewed
Nov 21, 2023
There was a problem hiding this comment.
Nice! I agree with @mnajdova's comments, after fixing those this is RTM.
|
Updated and added some more tweaks ~ |
DiegoAndai
approved these changes
Nov 22, 2023
There was a problem hiding this comment.
LGTM 🎉
When it's merged, we should remove it from the issue and add a link to this one instead 🙌🏼
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Nov 30, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 1, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 1, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 6, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 6, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I copied the contributing guide from #29345 to make it a bit more visible, and to un-bloat that issue a bit ~
We can replace the content in the issue with a link once this is merged