Skip to content

Commit 0ad8a42

Browse files
committed
updating readme some more
1 parent 8abb509 commit 0ad8a42

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ You will need to [install docker](https://example.com) on your local machine.
3939

4040
To get started with Code Racer locally, follow these steps
4141

42-
1. Clone the repo
42+
1. Fork my repo and clone your fork
4343
```sh
44-
git clone https://github.com/webdevcody/code-racer.git
44+
git clone https://github.com/YOUR_USERNAME/code-racer.git
4545
```
4646
2. Navigate to the project directory
4747

@@ -78,6 +78,27 @@ To get started with Code Racer locally, follow these steps
7878

7979
Open your browser and visit http://localhost:3000 to see the application running.
8080

81+
## How to Contribute
82+
83+
### Working on New Features
84+
85+
If you want to work on a new feature, follow these steps.
86+
87+
1. fork the repo
88+
2. clone your fork
89+
3. checkout a new branch
90+
4. do you work,
91+
5. commit
92+
6. push your branch to your fork
93+
7. go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN
94+
95+
### Pulling in changes from upstream
96+
97+
You should pull in the changes that we add in daily, preferably before you checkout a new branch to do new work.
98+
99+
1. git checkout main
100+
2. git pull upstream main
101+
81102
## License
82103

83104
The Code Racer project is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.

0 commit comments

Comments
 (0)