24 lines
432 B
Markdown
24 lines
432 B
Markdown
|
# Contributing
|
||
|
|
|
||
|
|
If you submit a pull request, please keep the following guidelines in mind:
|
||
|
|
|
||
|
|
1. Code should be `go fmt` compliant.
|
||
|
|
2. Types, structs and funcs should be documented.
|
||
|
|
3. Tests pass.
|
||
|
|
|
||
|
|
## Getting set up
|
||
|
|
|
||
|
|
Assuming your `$GOPATH` is set up according to your desires, run:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
go get github.com/digitalocean/godo
|
||
|
|
```
|
||
|
|
|
||
|
|
## Running tests
|
||
|
|
|
||
|
|
When working on code in this repository, tests can be run via:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
go test .
|
||
|
|
```
|