Skip to content

[docs] Revise the Contributing Guide #39190

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Oct 12, 2023
Merged

[docs] Revise the Contributing Guide #39190

merged 10 commits into from
Oct 12, 2023

Conversation

mapache-salvaje
Copy link
Contributor

@mapache-salvaje mapache-salvaje commented Sep 27, 2023 •
edited
Loading

  • 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

@mapache-salvaje mapache-salvaje added the docs Improvements or additions to the documentation label Sep 27, 2023
@mui-bot
Copy link

mui-bot commented Sep 27, 2023 •
edited
Loading

Netlify deploy preview

https://deploy-preview-39190--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 94265f2

danilo-leal
danilo-leal reviewed Sep 27, 2023
View reviewed changes
@mapache-salvaje mapache-salvaje mentioned this pull request Sep 27, 2023
Closed
1 task
@mapache-salvaje mapache-salvaje marked this pull request as ready for review September 27, 2023 19:31
@mapache-salvaje @danilo-leal
Update CONTRIBUTING.md
4c8ac0f 
Co-authored-by: Danilo Leal <[email protected]>
Signed-off-by: Sam Sycamore <[email protected]>
danilo-leal
danilo-leal approved these changes Sep 28, 2023
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a 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 😬

mbrookes
mbrookes reviewed Oct 2, 2023
View reviewed changes
mbrookes
mbrookes reviewed Oct 2, 2023
View reviewed changes
mbrookes
mbrookes reviewed Oct 2, 2023
View reviewed changes
@mj12albert mj12albert mentioned this pull request Oct 3, 2023
Closed
2 tasks
@mapache-salvaje @danilo-leal
Apply suggestions from code review
87693bb 
Co-authored-by: Danilo Leal <[email protected]>
Signed-off-by: Sam Sycamore <[email protected]>
mbrookes
mbrookes reviewed Oct 7, 2023
View reviewed changes
Copy link
Member

@mbrookes mbrookes left a comment •
edited
Loading

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.

@mapache-salvaje mapache-salvaje changed the title [docs] Add note about translations to Contributing Guide, plus general copy editing [docs] Revise the Contributing Guide Oct 10, 2023
@mapache-salvaje
Copy link
Contributor Author

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.

@mapache-salvaje mapache-salvaje requested review from mbrookes and danilo-leal and removed request for mnajdova October 10, 2023 01:28
danilo-leal
danilo-leal approved these changes Oct 10, 2023
View reviewed changes
Copy link
Contributor

@danilo-leal danilo-leal left a 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! 😄

@mbrookes mbrookes merged commit ec9178d into mui:master Oct 12, 2023
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Oct 13, 2023
@mapache-salvaje @danilo-leal
@mbrookes @mnajdova
[docs] Revise the Contributing Guide (mui#39190)
d29f163 
Signed-off-by: Sam Sycamore <[email protected]>
Co-authored-by: Danilo Leal <[email protected]>
Co-authored-by: Matt <[email protected]>
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Oct 13, 2023
@mapache-salvaje @danilo-leal
@mbrookes @mnajdova
[docs] Revise the Contributing Guide (mui#39190)
6815f6b 
Signed-off-by: Sam Sycamore <[email protected]>
Co-authored-by: Danilo Leal <[email protected]>
Co-authored-by: Matt <[email protected]>
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Oct 13, 2023
@mapache-salvaje @danilo-leal
@mbrookes @mnajdova
[docs] Revise the Contributing Guide (mui#39190)
345a6f3 
Signed-off-by: Sam Sycamore <[email protected]>
Co-authored-by: Danilo Leal <[email protected]>
Co-authored-by: Matt <[email protected]>
@mapache-salvaje mapache-salvaje deleted the contributing-translations branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mbrookes mbrookes mbrookes approved these changes

@danilo-leal danilo-leal danilo-leal approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mapache-salvaje @mui-bot @mbrookes @danilo-leal