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

[core] Improve CONTRIBUTING.md local install instructions #32975

Merged
merged 8 commits into from Jun 10, 2022

Conversation

Moizsohail
Copy link
Contributor

@Moizsohail Moizsohail commented Jun 1, 2022

Testing and debugging locally was a huge hassle and was very time consuming, especially for a beginner like me who has to console.log everything to understand what's going on. These instructions, will help save a lot of time debugging user changes.

Furthermore, these changes can later further be incorporated into a script to automate the whole process.

@Moizsohail
Copy link
Contributor Author

Need review @samuelsycamore

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have left some suggestions for style and grammar.

Additionally, I think this section needs further elaboration. I'm not familiar with this kind of workflow, and I am not able to reproduce it just by following the instructions here. Can you add more details?

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
Moizsohail and others added 2 commits June 8, 2022 00:25
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
@Moizsohail
Copy link
Contributor Author

Can you share which part are you getting stuck on or which part do you need more clarification?

@Moizsohail
Copy link
Contributor Author

@samuelsycamore Made some changes.

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Moizsohail! I was able to make it work after following the instructions this time around. 🙌 I've just added some small changes for style consistency.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@mui-bot
Copy link

mui-bot commented Jun 9, 2022

No bundle size changes

Generated by 🚫 dangerJS against ed48ea3

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Almost forgot that yarn markdownlint is going to require that the language is specified for code blocks!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@samuelsycamore samuelsycamore added the docs Improvements or additions to the documentation label Jun 9, 2022
@Moizsohail
Copy link
Contributor Author

How will this get merged now?

@mnajdova mnajdova merged commit feb643b into mui:master Jun 10, 2022
@oliviertassinari oliviertassinari changed the title [Contributing.md] Local install instructions [core] Improve CONTRIBUTING.md local install instructions Jun 17, 2022
@oliviertassinari oliviertassinari added the core Infrastructure work going on behind the scenes label Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants