Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated the docs for better understanding #774

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

updated the docs for better understanding #774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Commit: [2] feat: add docker container for postgres

You will need to [install docker](https://www.docker.com/get-started/) on your local machine.

If you do not have docker, go here to download and install: <https://www.docker.com/get-started/>
If you do not have docker, go at the below link to download and install:
<https://www.docker.com/get-started/>

If you see error starting db on M1 mac, you may need to update your docker config file at `~/.docker/config.json`
Your file should look like something like this:
Expand All @@ -44,11 +45,11 @@ If you are getting WSL error when you launch your desktop docker application, go

To get started with Code Racer locally, follow these steps

1. Make sure you have installed Docker locally (See above Prerequisites)
1. Make sure you have installed Docker locally (See above Prerequisites if not yet installed)

2. Fork the repository as your own repo

3. Clone forked repo to your local machine
3. Clone forked repo to your local machine with the help of the following command:

```sh
git clone https://github.com/<YOUR_GITHUB_ACCOUNT_NAME>/code-racer.git
Expand All @@ -64,7 +65,7 @@ To get started with Code Racer locally, follow these steps

6. Copy and paste variables from `packages/app/.env.example` into `packages/app/.env`

7. Install NPM packages
7. Install NPM(Node Package Manager) packages

```sh
npm i
Expand Down Expand Up @@ -99,7 +100,7 @@ There is also a new video explaining how you can contribute to this project:
<br/>
[How to contribute to open source projects (our community project walkthrough)](https://www.youtube.com/watch?v=dLRA1lffWBw)

If you want to work on a new feature, follow these steps.
If you want to work on a new feature, follow these steps:-

1. Fork the repository
2. Clone your fork
Expand All @@ -111,7 +112,8 @@ If you want to work on a new feature, follow these steps.

## Pulling in changes from upstream

You should pull in the changes that we add in daily, preferably before you checkout a new branch to do new work.
You should pull in the changes that we add in daily.
Preferably before you checkout a new branch to do new work.

```sh
git checkout main
Expand Down