File tree Expand file tree Collapse file tree 2 files changed +20
-11
lines changed Expand file tree Collapse file tree 2 files changed +20
-11
lines changed Original file line number Diff line number Diff line change 1
1
# Contributing
2
2
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
4
20
5
21
Contributions must adhere to [ Effective Go] ( https://go.dev/doc/effective_go ) . Linting rules should
6
22
be preferred over documenting styles (run ours with ` make lint ` ); humans are error prone!
7
23
8
24
Read [ Go's Code Review Comments Wiki] ( https://github.com/golang/go/wiki/CodeReviewComments ) to find
9
25
common comments made during reviews of Go code.
10
26
11
- ### No Unused Packages
27
+ #### No Unused Packages
12
28
13
29
Coders write packages that are used during implementation. It's difficult to validate whether an
14
30
abstraction is valid until it's checked against an implementation. This results in a larger
Original file line number Diff line number Diff line change @@ -62,14 +62,7 @@ $ vim main.tf
62
62
$ coder projects update gcp-linux
63
63
```
64
64
65
- ## Development
65
+ ## Contributing
66
66
67
- Read the [ contributing docs] ( ./CONTRIBUTING.md ) for style and review guidelines .
67
+ Read the [ contributing docs] ( ./CONTRIBUTING.md ) .
68
68
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
You can’t perform that action at this time.
0 commit comments