Skip to content

Commit 584c8b4

Browse files
authored
docs: move development workflow to CONTRIBUTING (#890)
1 parent dc55e35 commit 584c8b4

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

docs/CONTRIBUTING.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
# Contributing
22

3-
## Go Style
3+
## Requirements
4+
5+
`coder` requires Go 1.18+, Node 14+, and GNU Make.
6+
7+
### Development Workflow
8+
9+
The following `make` commands and scripts used in development:
10+
11+
- `make bin` builds binaries
12+
- `make install` installs binaries to `$GOPATH/bin`
13+
- `make test`
14+
- `make release` dry-runs a new release
15+
- `./develop.sh` hot-reloads for frontend development
16+
17+
## Styling
18+
19+
### Go Style
420

521
Contributions must adhere to [Effective Go](https://go.dev/doc/effective_go). Linting rules should
622
be preferred over documenting styles (run ours with `make lint`); humans are error prone!
723

824
Read [Go's Code Review Comments Wiki](https://github.com/golang/go/wiki/CodeReviewComments) to find
925
common comments made during reviews of Go code.
1026

11-
### No Unused Packages
27+
#### No Unused Packages
1228

1329
Coders write packages that are used during implementation. It's difficult to validate whether an
1430
abstraction is valid until it's checked against an implementation. This results in a larger

docs/README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,7 @@ $ vim main.tf
6262
$ coder projects update gcp-linux
6363
```
6464

65-
## Development
65+
## Contributing
6666

67-
Read the [contributing docs](./CONTRIBUTING.md) for style and review guidelines.
67+
Read the [contributing docs](./CONTRIBUTING.md).
6868

69-
Coder requires Go 1.18+, Node 14+, and GNU Make.
70-
71-
- `make bin` builds binaries
72-
- `make install` installs binaries to `$GOPATH/bin`
73-
- `make test`
74-
- `make release` dry-runs a new release
75-
- `./develop.sh` hot-reloads for frontend development

0 commit comments

Comments
 (0)