From 548087696027753f22bbc7df4fb87ac0c551b54a Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 6 Apr 2022 10:11:21 -0700 Subject: [PATCH] docs: move development workflow to CONTRIBUTING --- docs/CONTRIBUTING.md | 20 ++++++++++++++++++-- docs/README.md | 11 ++--------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 1333d00eacbf4..98627e9fb6d86 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,6 +1,22 @@ # Contributing -## Go Style +## Requirements + +`coder` requires Go 1.18+, Node 14+, and GNU Make. + +### Development Workflow + +The following `make` commands and scripts used in development: + +- `make bin` builds binaries +- `make install` installs binaries to `$GOPATH/bin` +- `make test` +- `make release` dry-runs a new release +- `./develop.sh` hot-reloads for frontend development + +## Styling + +### Go Style Contributions must adhere to [Effective Go](https://go.dev/doc/effective_go). Linting rules should be preferred over documenting styles (run ours with `make lint`); humans are error prone! @@ -8,7 +24,7 @@ be preferred over documenting styles (run ours with `make lint`); humans are err Read [Go's Code Review Comments Wiki](https://github.com/golang/go/wiki/CodeReviewComments) to find common comments made during reviews of Go code. -### No Unused Packages +#### No Unused Packages Coders write packages that are used during implementation. It's difficult to validate whether an abstraction is valid until it's checked against an implementation. This results in a larger diff --git a/docs/README.md b/docs/README.md index 694f1f70309b3..6fbbc7f02ea0a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -62,14 +62,7 @@ $ vim main.tf $ coder projects update gcp-linux ``` -## Development +## Contributing -Read the [contributing docs](./CONTRIBUTING.md) for style and review guidelines. +Read the [contributing docs](./CONTRIBUTING.md). -Coder requires Go 1.18+, Node 14+, and GNU Make. - -- `make bin` builds binaries -- `make install` installs binaries to `$GOPATH/bin` -- `make test` -- `make release` dry-runs a new release -- `./develop.sh` hot-reloads for frontend development