Quickstart guide was missing upstream remote command

nginxinc · May 20, 2024 · 170bc7f · 170bc7f
1 parent 10bae0b
commit 170bc7f
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/docs/developer/quickstart.md b/docs/developer/quickstart.md
@@ -31,10 +31,10 @@ Follow these steps to set up your development environment.
    ```
 
 2. [Fork the project repository](https://github.com/nginxinc/nginx-gateway-fabric/fork)
-3. Clone your repository, and install the project dependencies:
+3. Clone your repository with ssh, and install the project dependencies:
 
    ```shell
-   git clone https://github.com/<YOUR-USERNAME>/nginx-gateway-fabric.git
+   git clone git@github.com:<YOUR-USERNAME>/nginx-gateway-fabric.git
    cd nginx-gateway-fabric
    ```
 
@@ -50,6 +50,12 @@ Follow these steps to set up your development environment.
    make deps
    ```
 
+4. Finally, add the original project repository as the remote upstream:
+
+   ```shell
+   git remote add upstream git@github.com:nginxinc/nginx-gateway-fabric.git
+   ```
+
 
 ## Build the Binary and Images