You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 584c8b4
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+18-2Lines changed: 18 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,30 @@
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
0 commit comments