docs: update heading levels

This commit is contained in:
Jack 2023-08-31 13:58:51 +02:00 committed by GitHub
parent fd5f350b8b
commit 4d335e24ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,6 @@
# Contributing - Advanced
### **Table of Contents**
## **Table of Contents**
- [Prerequisites](#prerequisites)
- [Git](#git)
@ -16,13 +16,13 @@
This contribution guide is for cases in which you need to test the functionality of your changes, or if you need to take screenshots of your changes. You will need a computer with a stable internet connection, a text editor, Git, and NodeJS with version 16.13.2. There are some additional requirements depending on what you're looking to contribute, such as Firebase for authentication, Mongo and Docker for the backend. Read the below sections to understand how to set up each of these tools.
#### Git
### Git
**IMPORTANT: If you are on Windows, run `git config --global core.autocrlf false` before cloning this repo to prevent CRLF errors.**
Git is optional but we recommend you utilize it. Monkeytype uses the Git source control management (SCM) system for its version control. Assuming you don't have experience typing commands in the command line, we suggest installing [Sourcetree](https://www.sourcetreeapp.com/). You will be able to utilize the power of Git without needing to remember any cryptic commands. Using a Git client such as Sourcetree won't give you access to the full functionality of Git, but provides an easy to understand graphical user interface (GUI). Once you have downloaded Sourcetree, run the installer. While installing Sourcetree, keep your eyes peeled for the option to also install Git with Sourcetree. This is the option you will need to look for in order to install Git. **Make sure to click yes in the installer to install Git with Sourcetree.**
#### NodeJS and NPM
### NodeJS and NPM
Currently, the project is using version `18.17.1 LTS`.
@ -30,11 +30,11 @@ If you use `nvm` (if you use Windows, use [nvm-windows](https://github.com/corey
Alternatively, you can navigate to the NodeJS [website](https://nodejs.org/en/) to download it from there.
#### Docker (Recommended but Optional)
### Docker (Recommended but Optional)
You can use docker to run the frontend and backend. This will take care of OS specific problems, but might be a bit more resource intensive. You can download it from the [Docker website](https://www.docker.com/get-started/#h_installation).
#### Firebase (optional)
### Firebase (optional)
The account system will not let you create an account without a Firebase project. You can skip this if you don't think you will need it (you can always set it up later)
@ -71,7 +71,7 @@ The account system will not let you create an account without a Firebase project
}
```
#### Config file
### Config file
Within the `frontend/src/ts/constants` directory, duplicate `firebase-config-example.ts`, rename it to `firebase-config.ts`
@ -83,7 +83,7 @@ Within the `frontend/src/ts/constants` directory, duplicate `firebase-config-exa
4. The Firebase config will be visible below
5. Paste the config into `firebase-config.ts`
#### Backend (optional)
### Backend (optional)
Follow these steps if you want to work on anything involving the database/account system. Otherwise, you can skip this section.