monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2025-02-06 05:43:47 +08:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #359 from zachy-ho/add-CONTRIBUTING

Browse source 
Moved notes on contributing to CONTRIBUTING.md
This commit is contained in:
Jack 2020-09-16 17:27:12 +01:00 committed by GitHub
commit e206f49894
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 38 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,37 @@
# Contributing
## Project Setup
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 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 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:
```.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.
## Questions
If you run into any problems, let [me](https://github.com/Miodec) know.

9
README.md
View file

@ -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.