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.