mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:45:56 +00:00
docs: update CONTRIBUTING requirements (#3541)
* docs: update CONTRIBUTING requirements * Update docs/CONTRIBUTING.md * refactor: remove dev from Makefile * fixup: add linux section
This commit is contained in:
5
Makefile
5
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
|
||||
|
@ -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`
|
||||
|
Reference in New Issue
Block a user