This guide is focused on getting the best out of GitHub as a tool.
In Engineering, you will find related content on how we use GitHub to implement our desired work methodology and product engineering culture.
Recommendations for best-managed GitHub notifications:
Disable Pull request push notifications https://github.com/settings/notifications
Pushes create a lot of noise, they usually leave PRs in an incomplete state. Instead, you can wait for the author of the PR to ask for a new review. If you would rather regularly check the progress of a task, you can snooze the previous notification for x days rather than wait for pushes.
Use email notifications; don't use GitHub notifications UI. This is because:
If you are using email to manage notifications, we recommend enabling a few filter rules to reduce noise:
PR helper comment (group a bunch of stuff, bundle size, preview, etc.)
Matches: from:(vercel[bot] [email protected]) OR from:(codspeed-hq[bot] [email protected]) OR from:(mui-bot [email protected]) OR from:(render[bot] [email protected]) OR from:(netlify[bot] [email protected]) Do this: Delete it
e.g. https://github.com/mui/material-ui/pull/43785#issuecomment-2352519788
CSAT issue notification.
Matches: from:(github-actions[bot] [email protected]) "This issue has been closed" Do this: Delete it
e.g. https://github.com/mui/material-ui/issues/43700#issuecomment-2352765908
While you can see the following:
On your profile page:
GitHub issues and PRs:
The community can’t see that you are part of the MUI organization. By default, GitHub makes any new member of an organization private on their profile, so the community will see this instead:
On your profile page: nothing
“Contributor” rather than “Member”:
This can be problematic because it means that the community doesn’t know exactly who they are talking to, e.g., who they are receiving an answer on their GitHub issue from or who left a review on their PRs. They might confuse you with a user of the library.
More transparency can help; you can make this visible by**:**
https://github.com/orgs/mui/people - Switch your organization visibility from private to public: