From 78b624023a389dadd76808a45e9d324435c9bf05 Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Tue, 15 Sep 2020 23:53:17 +1000 Subject: [PATCH 1/6] Moved Contributing notes to CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ README.md | 9 +-------- 2 files changed, 18 insertions(+), 8 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..aac553c9d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# how to contribute + +1. Head to [the firebase console](https://console.firebase.google.com/u/0/) and make a new project (the project name doesnt really matter, but just name it `monkey-type`). You dont need to enable analytics for it. +2. Install the [Firebase Command Line Interface](https://firebase.google.com/docs/cli), and use `firebase login` to log in to the same google account as you just used to make the project. +3. Git clone the project and make sure to rename `.firebaserc_example` to `.firebaserc` and change the project name inside to your firebase project name you just created. + - If `.firebaserc_example` does not exist after cloning, create your own: + `{ "projects": { "default": "monkey-type-dev-67af4", "live": "monkey-type" } }` + - The "live" option in `.firebaserc_example` is not necessary. +4. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it. +5. Run `firebase use default` if you run into any errors on step 5. + +## standards & conventions + +1. Use a SCSS compiler. For VSCode I recommend `Easy Sass` or `Live Sass Compiler` extension. +2. Install [Prettier](https://prettier.io/docs/en/install.html). Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code. + +That should be it. If you run into any problems, let me know. diff --git a/README.md b/README.md index 5a1951e45..5b874e8cf 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,4 @@ If you wish to support further development and feeling extra awesome, you can do # how to contribute -1. Head to [the firebase console](https://console.firebase.google.com/u/0/) and make a new project (the project name doesnt really matter, but just name it `monkey-type`). You dont need to enable analytics for it. -2. Install the [Firebase Command Line Interface](https://firebase.google.com/docs/cli), and use `firebase login` to log in to the same google account as you just used to make the project. -3. Git clone the project and make sure to rename `.firebaserc_example` to `.firebaserc` and change the project name inside to your firebase project name you just created. -4. Make sure you use a SCSS compiler. For VSCode I recommend `Easy Sass` or `Live Sass Compiler` extension. -5. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it. -6. Make sure to install `Prettier`. Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code. - -That should be it. If you run into any problems, let me know. +Refer to CONTRIBUTING.md. From 789a5f47cc1e321dfc9392932e679b37dd59db0f Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Wed, 16 Sep 2020 00:01:36 +1000 Subject: [PATCH 2/6] changed CONTRIBUTING.md codeblock format --- CONTRIBUTING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aac553c9d..2d407e75d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,9 +3,18 @@ 1. Head to [the firebase console](https://console.firebase.google.com/u/0/) and make a new project (the project name doesnt really matter, but just name it `monkey-type`). You dont need to enable analytics for it. 2. Install the [Firebase Command Line Interface](https://firebase.google.com/docs/cli), and use `firebase login` to log in to the same google account as you just used to make the project. 3. Git clone the project and make sure to rename `.firebaserc_example` to `.firebaserc` and change the project name inside to your firebase project name you just created. + - If `.firebaserc_example` does not exist after cloning, create your own: - `{ "projects": { "default": "monkey-type-dev-67af4", "live": "monkey-type" } }` + + { + "projects": { + "default": "monkey-type-dev-67af4", + "live": "monkey-type" + } + } + - The "live" option in `.firebaserc_example` is not necessary. + 4. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it. 5. Run `firebase use default` if you run into any errors on step 5. From 872c2c90eade245f9b774a641dde0870585ae563 Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Wed, 16 Sep 2020 00:05:07 +1000 Subject: [PATCH 3/6] changed CONTRIBUTING.md codeblock format --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d407e75d..0dee02d75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,12 +6,14 @@ - If `.firebaserc_example` does not exist after cloning, create your own: +````.firebaserc { - "projects": { - "default": "monkey-type-dev-67af4", - "live": "monkey-type" - } + "projects": { + "default": "monkey-type-dev-67af4", + "live": "monkey-type" + } } + ``` - The "live" option in `.firebaserc_example` is not necessary. @@ -24,3 +26,4 @@ 2. Install [Prettier](https://prettier.io/docs/en/install.html). Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code. That should be it. If you run into any problems, let me know. +```` From a58db74f558d5fe53a2300bee234a0254027bcd1 Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Wed, 16 Sep 2020 00:06:31 +1000 Subject: [PATCH 4/6] changed CONTRIBUTING.md codeblock format --- CONTRIBUTING.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0dee02d75..209aaec5e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,14 +6,14 @@ - If `.firebaserc_example` does not exist after cloning, create your own: -````.firebaserc - { - "projects": { - "default": "monkey-type-dev-67af4", - "live": "monkey-type" - } - } - ``` + ```.firebaserc + { + "projects": { + "default": "monkey-type-dev-67af4", + "live": "monkey-type" + } + } + ``` - The "live" option in `.firebaserc_example` is not necessary. @@ -26,4 +26,3 @@ 2. Install [Prettier](https://prettier.io/docs/en/install.html). Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code. That should be it. If you run into any problems, let me know. -```` From efac001e71799bebca3cde3abfa79cc38a350637 Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Wed, 16 Sep 2020 00:28:15 +1000 Subject: [PATCH 5/6] changed CONTRIBUTING.md structure --- CONTRIBUTING.md | 45 +++++++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 209aaec5e..d1d76af7b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,37 @@ -# how to contribute +# Contributing -1. Head to [the firebase console](https://console.firebase.google.com/u/0/) and make a new project (the project name doesnt really matter, but just name it `monkey-type`). You dont need to enable analytics for it. -2. Install the [Firebase Command Line Interface](https://firebase.google.com/docs/cli), and use `firebase login` to log in to the same google account as you just used to make the project. -3. Git clone the project and make sure to rename `.firebaserc_example` to `.firebaserc` and change the project name inside to your firebase project name you just created. +## Project Setup - - If `.firebaserc_example` does not exist after cloning, create your own: +1. [Make a new Firebase project. ](https://console.firebase.google.com/u/0/) - ```.firebaserc - { - "projects": { - "default": "monkey-type-dev-67af4", - "live": "monkey-type" - } - } - ``` + - The project name doesn't really matter, but just name it `monkey-type`. + - Google Analytics not necessary. - - The "live" option in `.firebaserc_example` is not necessary. +2. [Install the Firebase CLI](https://firebase.google.com/docs/cli) +3. Run `firebase login` on your terminal to log in to the same google account as you just used to make the project. +4. Git clone the project. +5. Rename `.firebaserc_example` to `.firebaserc` and change the project name of default to the firebase project id you just created. -4. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it. -5. Run `firebase use default` if you run into any errors on step 5. + - If `.firebaserc_example` does not exist after cloning, create your own with: -## standards & conventions + ```.firebaserc + { + "projects": { + "default": "your-firebase-project-id", + } + } + ``` + + - Run `firebase projects:list` to find your firebase project id. + +6. Run `firebase serve` to start a local server on port 5000. Use ctrl+c to stop it. + - Run `firebase use default` if you run into any errors for this. + +## Standards & Conventions 1. Use a SCSS compiler. For VSCode I recommend `Easy Sass` or `Live Sass Compiler` extension. 2. Install [Prettier](https://prettier.io/docs/en/install.html). Its a code formatter, and it will make sure that we avoid any whitespace or formatting issues when merging code. -That should be it. If you run into any problems, let me know. +## Questions + +That should be it. If you run into any problems, let [me](https://github.com/Miodec) know. From 6fe4cac3839a092f324996604a202079c73adbb1 Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Wed, 16 Sep 2020 00:30:32 +1000 Subject: [PATCH 6/6] minor changes to CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d1d76af7b..797e0718c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,14 +2,14 @@ ## Project Setup -1. [Make a new Firebase project. ](https://console.firebase.google.com/u/0/) +1. [Create a new Firebase project. ](https://console.firebase.google.com/u/0/) - The project name doesn't really matter, but just name it `monkey-type`. - - Google Analytics not necessary. + - Google Analytics is not necessary. 2. [Install the Firebase CLI](https://firebase.google.com/docs/cli) -3. Run `firebase login` on your terminal to log in to the same google account as you just used to make the project. -4. Git clone the project. +3. Run `firebase login` on your terminal to log in to the same google account as you just used to create the project. +4. Git clone this project. 5. Rename `.firebaserc_example` to `.firebaserc` and change the project name of default to the firebase project id you just created. - If `.firebaserc_example` does not exist after cloning, create your own with: @@ -34,4 +34,4 @@ ## Questions -That should be it. If you run into any problems, let [me](https://github.com/Miodec) know. +If you run into any problems, let [me](https://github.com/Miodec) know.