Skip to content

docs: update CONTRIBUTING requirements #3541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 18, 2022
Merged

docs: update CONTRIBUTING requirements #3541

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd9a24f
docs: update CONTRIBUTING requirements
jsjoeio Aug 17, 2022
53852e6
Update docs/CONTRIBUTING.md
jsjoeio Aug 18, 2022
b963bef
refactor: remove dev from Makefile
jsjoeio Aug 18, 2022
6aa9e83
fixup: add linux section
jsjoeio Aug 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
- [`zstd`](https://github.com/horta/zstd.install)
- [`pg_dump`]
- on macOS, run `brew install libpq zstd`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't sure if this would confuse people since I technically list zstd twice, but also because I put pg_dump but then tell people to install libpq and zstd. Open to better ideas!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could break out into separate Linux and MacOS sections, perhaps?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! I went with this for now: 6aa9e83


> **Note**:
> Use [Nix](https://nix.dev/) for a one-command setup: `nix-shell`
Expand All @@ -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`
Expand Down