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
Conversation
Need review @samuelsycamore |
There was a problem hiding this 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?
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Can you share which part are you getting stuck on or which part do you need more clarification? |
@samuelsycamore Made some changes. |
There was a problem hiding this 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.
There was a problem hiding this 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!
How will this get merged now? |
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.