From 690de5287cbb2d95e431e77975b2a270aa524151 Mon Sep 17 00:00:00 2001 From: Sindhu Shiv Date: Tue, 7 May 2024 14:29:04 -0700 Subject: [PATCH] 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. --- docs/developer/quickstart.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/developer/quickstart.md b/docs/developer/quickstart.md index f77fbbe5d2..75ec82a357 100644 --- a/docs/developer/quickstart.md +++ b/docs/developer/quickstart.md @@ -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: @@ -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