From 78b624023a389dadd76808a45e9d324435c9bf05 Mon Sep 17 00:00:00 2001 From: Zachary Ho Date: Tue, 15 Sep 2020 23:53:17 +1000 Subject: [PATCH] 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.