From 078471a2be06deb85c5eb6d05f8a4e0f0f00961f Mon Sep 17 00:00:00 2001
From: Chris Banks <chris.banks@digital.cabinet-office.gov.uk>
Date: Mon, 21 Aug 2023 16:25:34 +0100
Subject: [PATCH] Improve first-build experience.

- Emit a more helpful message when the golangci-lint command isn't
  present.
- Fix the README so that installing the linter comes before running the
  `make` target that requires it.
- Mention how to run specific integration tests.
---
 Makefile  |  5 +++++
 README.md | 32 +++++++++++++++-----------------
 2 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/Makefile b/Makefile
index 949be474..569924bb 100644
--- a/Makefile
+++ b/Makefile
@@ -17,6 +17,11 @@ build:
 test: lint unit_tests integration_tests
 
 lint:
+	@if ! command -v golangci-lint; then \
+		echo "linting uses golangci-lint: you can install it with:\n"; \
+		echo "    brew install golangci-lint\n"; \
+		exit 1; \
+	fi
 	golangci-lint run
 
 unit_tests:
diff --git a/README.md b/README.md
index 35b36d0c..f09c634a 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,16 @@ Recommended reading: [How to Write Go Code](https://golang.org/doc/code.html)
 
 ### Run the test suite
 
+Checks run automatically on GitHub on PR and push. For faster feedback, you can
+run the tests locally.
+
+The lint check uses [golangci-lint](https://golangci-lint.run/), which you can
+install via Homebrew or your favourite package manager:
+
+```sh
+brew install golangci-lint
+```
+
 You can run all tests (some of which need Docker installed) by running:
 
 ```
@@ -29,32 +39,20 @@ make test
 You can also run just the unit tests or just the integration tests, using the
 `unit_tests` and `integration_tests` targets. The unit tests don't need Docker.
 
-The `trie` and `triemux` sub-packages have unit tests and benchmarks written
-in Go's own testing framework. To run them individually:
+The `trie` and `triemux` packages have unit tests. To run these on their own:
 
 ```
 go test -bench=. ./trie ./triemux
 ```
 
-The integration tests require Docker in order to run MongoDB. They are intended
+The integration tests need Docker in order to run MongoDB. They are intended
 to cover Router's overall request handling, error reporting and performance.
 
-```
-go test ./integration_tests
-```
-
-### Lint
-
-Checks run automatically on GitHub on PR and push. For faster feedback, you can
-install and run the [linter](https://golangci-lint.run/) yourself, or configure
-your editor/IDE to do so. For example:
+You can use `--ginkgo.focus <partial regex>` to run a subset of the integration
+tests, for example:
 
-```sh
-brew install golangci-lint
 ```
-
-```sh
-make lint
+go test ./integration_tests -v --ginkgo.focus 'redirect should preserve the query string'
 ```
 
 ### Debug output