Skip to content

Commit

Permalink
Fixing the 'pre-commit install' command in the quick start guide of t…
Browse files Browse the repository at this point in the history
…he NGF (#1944)

Fixing the 'precommit install' command in the quick start guide of the NGF.

Problem: The 'precommit install' command needs to be executed after the git project is created.

Solution: Moved the 'precommit install' command to later in the instructions, after the fork and clone instructions are executed.

Testing (optional): Verified in the documentation whether it renders correctly.
  • Loading branch information
sindhushiv authored May 7, 2024
1 parent 97c37e5 commit 66f763e
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/developer/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,6 @@ Follow these steps to set up your development environment.
brew install pre-commit
```

and then run

```shell
pre-commit install
```

in the project root directory to install the git hooks.

2. [Fork the project repository](https://github.com/nginxinc/nginx-gateway-fabric/fork)
3. Clone your repository, and install the project dependencies:

Expand All @@ -46,10 +38,19 @@ Follow these steps to set up your development environment.
cd nginx-gateway-fabric
```

and then run

```shell
pre-commit install
```

in the project root directory to install the git hooks.

```makefile
make deps
```


## Build the Binary and Images

### Setting GOARCH
Expand Down

0 comments on commit 66f763e

Please sign in to comment.