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

[docs] Improve CONTRIBUTING.md #21303

Merged
merged 7 commits into from
Jun 5, 2020
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,14 @@ Working on your first Pull Request? You can learn how from this free video serie

[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)

To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/mui-org/material-ui/issues?q=is:open+is:issue+label:"good+first+issue") that contain changes that have a relatively limited scope. This is a great place to get started.
To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/mui-org/material-ui/issues?q=is:open+is:issue+label:"good+first+issue") that contain changes that have a relatively limited scope. This label means that there already is a working solution to the issue in the discussion section, and therefore is a great place to get started.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

We also have a list of [good to take issues](https://github.com/mui-org/material-ui/issues?q=is:open+is:issue+label:"good+to+take"). This label is applied when there has already been some discussion about the solution and there is a clear direction to go. This targets developers that want to reduce the chance of going down a rabbit hole.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you have started to work on it so other people don’t accidentally duplicate your effort.

If somebody claims an issue but doesn’t follow up for more than a week, it’s fine to take it over but you should still leave a comment.
If there has been no activity on the issue for 7 to 14 days it is safe to assume that nobody is working on it.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

## Sending a Pull Request

Expand Down Expand Up @@ -176,9 +179,10 @@ on their a11y-tree membership makes no difference. The queries where this does
make a difference explicitly include this check e.g. `getByRole('button', { hidden: false })` (see [byRole documentation](https://testing-library.com/docs/dom-testing-library/api-queries#byrole) for more information).
To see if your test (`test:browser` or `test:unit`) behaves the same between CI and local environment set the environment variable `CI` to `'true'`.

### Testing the documentation site
### Testing the changes on the documentation site
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

The documentation site is built with Material-UI and contains examples of all the components.
This is the best place to test your changes.
oliviertassinari marked this conversation as resolved.
Show resolved Hide resolved

To get started:

Expand Down