From aabb72783c816efda7c76e94974150184012ef5e Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Thu, 18 Aug 2022 10:11:58 -0700 Subject: [PATCH] docs: update CONTRIBUTING requirements (#3541) * docs: update CONTRIBUTING requirements * Update docs/CONTRIBUTING.md * refactor: remove dev from Makefile * fixup: add linux section --- Makefile | 5 ----- docs/CONTRIBUTING.md | 12 ++++++++++-- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index 997cbc0d4e..08df31dfce 100644 --- a/Makefile +++ b/Makefile @@ -63,11 +63,6 @@ coderd/database/dump.sql: $(wildcard coderd/database/migrations/*.sql) coderd/database/querier.go: coderd/database/sqlc.yaml coderd/database/dump.sql $(wildcard coderd/database/queries/*.sql) coderd/database/generate.sh -# This target is deprecated, as GNU make has issues passing signals to subprocesses. -dev: - @echo Please run ./scripts/develop.sh manually. -.PHONY: dev - fmt/prettier: @echo "--- prettier" cd site diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 6d3a749ac5..184c1f4cca 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -2,7 +2,15 @@ ## Requirements -Coder requires Go 1.18+, Node 14+, and GNU Make. +You'll need the following tools: +- Go 1.18+ +- Node 14+ +- GNU Make +- [`shfmt`](https://github.com/mvdan/sh#shfmt) +- [`nfpm`](https://nfpm.goreleaser.com/install) +- [`pg_dump`] + - on macOS, run `brew install libpq zstd` + - on Linux, install [`zstd`](https://github.com/horta/zstd.install) > **Note**: > Use [Nix](https://nix.dev/) for a one-command setup: `nix-shell` @@ -11,7 +19,7 @@ Coder requires Go 1.18+, Node 14+, and GNU Make. Use the following `make` commands and scripts in development: -- `make dev` runs the frontend and backend development server +- `./scripts/develop.sh` runs the frontend and backend development server - `make build` compiles binaries and release packages - `make install` installs binaries to `$GOPATH/bin` - `make test`