Skip to content

Commit 66f763e

Browse files
authored
Fixing the 'pre-commit install' command in the quick start guide of the 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.
1 parent 97c37e5 commit 66f763e

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/developer/quickstart.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,6 @@ Follow these steps to set up your development environment.
3030
brew install pre-commit
3131
```
3232

33-
and then run
34-
35-
```shell
36-
pre-commit install
37-
```
38-
39-
in the project root directory to install the git hooks.
40-
4133
2. [Fork the project repository](https://github.com/nginxinc/nginx-gateway-fabric/fork)
4234
3. Clone your repository, and install the project dependencies:
4335

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

41+
and then run
42+
43+
```shell
44+
pre-commit install
45+
```
46+
47+
in the project root directory to install the git hooks.
48+
4949
```makefile
5050
make deps
5151
```
5252

53+
5354
## Build the Binary and Images
5455

5556
### Setting GOARCH

0 commit comments

Comments
 (0)