[docs] Confusion around package managers

[FoopyPoopy]

Related page

https://github.com/mui/material-ui/blob/next/README.md

Kind of issue

Unclear explanations

Issue description

When using the documentation, I was attempting to contribute directly to a Material-UI example following the contributing guide, however, I wasn't an original user of the pnpm package manager. As such, I was very confused as to the reason why it said npm is not supported considering it's on the front page's README.md
Due to my own personal confusion with this, I figured adding a Quick Start section and a Note explaining to new users that all package managers are supported when using Material-UI in their own project, but that pnpm is the only manager supported when contributing directly to Material-UI.

Context

What I am trying to accomplish is just an ease of use update to the README.md for new users to see and understand better, along with ease of access to the commands for installation for all package managers instead of having to look up "material ui installation" everytime I need it. I also want to add a note to the CONTRIBUTING.md right before step 4. which specifies the reason pnpm is the only supported manager. I was unsure if this should be a documentation label or something else, as its related more to the Github Repo itself rather than the mui.com site.
Apologies if this is dense in text, it is my first time creating an issue and possibly pull requesting to an open source project.

Search keywords: package manager, pnpm, readme, contributing

[aarongarciah]

Hey @FoopyPoopy! As you pointed out, consumers can use any package manager to install npm packages. This not something unique to MUI npm packages. As you can see in Material UI installation docs, we showcase npm, yarn, and pnpm.

The badges you see in the README are a common way to document published npm versions and have nothing to do with which package manager consumers should use. Given how the README is used and structured today, adding more info about package managers and such would probably be more confusing.

Regarding updating CONTRIBUTING.md, I'm unsure if it would add any real value for consumers to know why only pnpm is supported when contributing to this repository. What could be valuable is adding a link to pnpm installation instructions: https://pnpm.io/installation.

[aarongarciah]

I've created this PR adding a link to the pnpm installation docs https://github.com/mui/material-ui/issues

[aarongarciah]

I'm closing the issue since we don't think there's anything to act on for now.

[FoopyPoopy]

Thank you so much for the reply Aaron. In regards to the PR you created about adding a link to pnpm installation docs, am i able to be assigned that? From what I'm seeing on my end its still nobody assigned to it and I don't see the changes reflected. Apologies if it was already changed and I am missing it.

[aarongarciah]

Hey @FoopyPoopy! The change was merged in master. You can see it at https://github.com/mui/material-ui/blob/master/CONTRIBUTING.md

We're working on v6 and our default base branch is next, so maybe you didn't see it if you checked the next branch.

If you want, you can open a PR cherry-picking the commit into next.

[FoopyPoopy]

Hey @FoopyPoopy! The change was merged in master. You can see it at https://github.com/mui/material-ui/blob/master/CONTRIBUTING.md

We're working on v6 and our default base branch is next, so maybe you didn't see it if you checked the next branch.

If you want, you can open a PR cherry-picking the commit into next.

I see okay, thank you. I see the change. I will look to see if there is something else I am able to contribute to within my capabilities. Thank you very much for the replies.