From 79e3135297454385b2b40680e027038b5459840c Mon Sep 17 00:00:00 2001 From: hitesh Date: Tue, 24 Dec 2019 16:47:05 +0530 Subject: [PATCH 1/3] docs: Missing package manager instructions from CONTRIBUTING.md --- CONTRIBUTING.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a5f96dfe286f6a..6020bfa73b9c2e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,10 @@ If you decide to fix an issue, please be sure to check the comment thread in cas 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. +## Package Manager + +Use [yarn](https://yarnpkg.com/en/docs) as a package manager to deal with project dependencies. + ## 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. @@ -31,7 +35,7 @@ When in doubt, keep your Pull Requests small. To give a Pull Request the best ch 1. Fork the repository. -2. Clone the fork to your local machine and add upstream remote +2. Clone the fork to your local machine and add upstream remote: ```sh git clone git@github.com:/material-ui.git @@ -46,19 +50,30 @@ git checkout master git pull upstream master ``` -4. Create a new topic branch: +4. Install dependencies: ```sh -git checkout -b my-topic-branch +yarn install ``` -5. Make changes, commit and push to your fork: +or + +````sh +yarn + +5. Create a new topic branch: + +```sh +git checkout -b my-topic-branch +```` + +6. Make changes, commit and push to your fork: ```sh git push -u ``` -6. Go to [the repository](https://github.com/mui-org/material-ui) and make a Pull Request. +7. Go to [the repository](https://github.com/mui-org/material-ui) and make a Pull Request. The core team is monitoring for Pull Requests. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation. From e098915f7c7a2889672ab92c8e8eb5cb6ba6711c Mon Sep 17 00:00:00 2001 From: hitesh Date: Tue, 24 Dec 2019 22:55:37 +0530 Subject: [PATCH 2/3] Remove package manager section --- CONTRIBUTING.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6020bfa73b9c2e..18037f30fffce5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,10 +23,6 @@ If you decide to fix an issue, please be sure to check the comment thread in cas 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. -## Package Manager - -Use [yarn](https://yarnpkg.com/en/docs) as a package manager to deal with project dependencies. - ## 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. From 252bf6cf27ee8d73968481bb3634bfcc872e6491 Mon Sep 17 00:00:00 2001 From: Olivier Tassinari Date: Tue, 24 Dec 2019 18:39:46 +0100 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18037f30fffce5..1f1cdc0df41a79 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,17 +46,12 @@ git checkout master git pull upstream master ``` -4. Install dependencies: +4. Install the dependencies: ```sh yarn install ``` -or - -````sh -yarn - 5. Create a new topic branch: ```sh