-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
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
[docs] Revise the Contributing Guide #39190
[docs] Revise the Contributing Guide #39190
Conversation
mapache-salvaje
commented
Sep 27, 2023
•
edited
Loading
edited
- Line breaks after each sentence for simpler line-by-line editing
- "Pull Request" —> "pull request" or "PR" - not sure why it was capitalized throughout most of this doc
- Sentence case for all headers
- Parallel structure for list items
- Rearranged steps for adding demos to the docs - it makes more sense to me to build the demo first, then add a section to the docs about it
- Copyediting everywhere, but especially "Your first pull request" section
- Grammar, style, typo fixes
Netlify deploy previewhttps://deploy-preview-39190--material-ui.netlify.app/ Bundle size report |
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
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.
Woo, this is much better — thanks for picking it up! 💪
My comments are mostly about the usage of "MUI" and how it's confusing sometimes 😬
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
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.
Removing the Translations section on the basis that #39221 will it make redundant.
Co-authored-by: Matt <github@nospam.33m.co> Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
In place of the translations section, I added a line to the "Wide spectrum of contributions" section suggesting that folks start by opening an issue if they have an idea for an improvement. |
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.
Looks super good! Left some small considerations, but am dropping the approval already! 😄
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Co-authored-by: Matt <github@nospam.33m.co>
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Co-authored-by: Matt <github@nospam.33m.co>
Signed-off-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com> Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com> Co-authored-by: Matt <github@nospam.33m.co>