opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update CONTRIBUTING requirements (#3541)

Browse Source 
* docs: update CONTRIBUTING requirements

* Update docs/CONTRIBUTING.md

* refactor: remove dev from Makefile

* fixup: add linux section
This commit is contained in:
Joe Previte
2022-08-18 17:11:58 +00:00
committed by GitHub
parent 55890df6f1
commit aabb72783c
2 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CONTRIBUTING.md
+10 -2
View File
@@ -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`