From 8046602895395f7fde78589646703b658a856d37 Mon Sep 17 00:00:00 2001 From: pedrooa Date: Wed, 3 Jun 2020 20:16:23 -0300 Subject: [PATCH 1/7] DOCS: fixes issue #21292 --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 22cc7eb9bd3a48..287336de62f1c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,12 +17,16 @@ 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. + +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. 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. + ## Sending a Pull Request Material-UI is a community project, so Pull Requests are always welcome, but, before working on a large change, it is best to open an issue first to discuss it with the maintainers. @@ -176,10 +180,12 @@ 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 The documentation site is built with Material-UI and contains examples of all the components. +This is the best place to test your changes. + To get started: ```sh From ce0c822e8a237aa835e59ca5b6e64b20eb7fe965 Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Jun 2020 01:26:44 +0200 Subject: [PATCH 2/7] Group related sentences --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 287336de62f1c4..1523f0f9694b92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,7 @@ We also have a list of [good to take issues](https://github.com/mui-org/material 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. +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. ## Sending a Pull Request @@ -183,7 +182,6 @@ To see if your test (`test:browser` or `test:unit`) behaves the same between CI ### Testing the changes on the documentation site The documentation site is built with Material-UI and contains examples of all the components. - This is the best place to test your changes. To get started: From 454f41843fbb497d7bf57598c91605fcc2ffdac1 Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Jun 2020 18:57:17 +0200 Subject: [PATCH 3/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1523f0f9694b92..dd24bb5b7f7587 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -182,7 +182,7 @@ To see if your test (`test:browser` or `test:unit`) behaves the same between CI ### Testing the changes on the documentation site The documentation site is built with Material-UI and contains examples of all the components. -This is the best place to test your changes. +This is a great place to experiment with your changes. To get started: From 872b9e15ca8db182c19cfd319f7c5ec96837d22a Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Jun 2020 18:57:36 +0200 Subject: [PATCH 4/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dd24bb5b7f7587..75517117ea0e5c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -179,7 +179,7 @@ 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 changes on the documentation site +### Trying the changes on the documentation site The documentation site is built with Material-UI and contains examples of all the components. This is a great place to experiment with your changes. From 544afff67c868881325a5f63c487e2c90d369429 Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Jun 2020 18:57:58 +0200 Subject: [PATCH 5/7] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Christian Jöcker <46030630+cjoecker@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 75517117ea0e5c..c221bfc887ea3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,7 @@ We also have a list of [good to take issues](https://github.com/mui-org/material 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. +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. ## Sending a Pull Request From f5629ed79e1c403469820b11e6b4fd5595bf072e Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Jun 2020 19:09:28 +0200 Subject: [PATCH 6/7] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c221bfc887ea3b..94770de7936263 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Working on your first Pull Request? You can learn how from this free video serie 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. -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. +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 set when there has been already some discussion about the solution and it is clear in which direction to go. These issues are good for developers that want to reduce the chance of going down a rabbit hole. 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. From 7b8e25ab43d858ed4a046be5512bcfee4c61755b Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Thu, 4 Jun 2020 19:10:06 +0200 Subject: [PATCH 7/7] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Christian Jöcker <46030630+cjoecker@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94770de7936263..164d6c0533fc6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ 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 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. +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 is already a working solution to the issue in the discussion section. Therefore, it is a great place to get started. 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 set when there has been already some discussion about the solution and it is clear in which direction to go. These issues are good for developers that want to reduce the chance of going down a rabbit hole.