diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96ae415..4b0d100 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,10 +2,8 @@ Before submitting a pull request: -- Please format your code with `gofmt` or `goimports`. -- Please fix warnings generated by `golint` and `go vet`. -- When changing the API, run `godoc -http=:6060`, point your browser to - http://localhost:6060/pkg/github.com/majewsky/schwift and check how your documentation looks. +- Please run `make check` and fix all warnings and errors. +- When changing the API, run `go doc -http` and check how the documentation looks. As a general rule of thumb, we prefer idiomatic Go code as described in: @@ -34,6 +32,6 @@ container](https://github.com/bouncestorage/docker-swift). group). Once that has come up successfully, press Ctrl-C to get back to your terminal prompt; the SAIO container will continue running. -2. Run the tests with `./testing/with-saio.sh go test`. The script will find how to access the Swift API inside the +2. Run the tests with `./testing/with-saio.sh make check`. The script will find how to access the Swift API inside the container, and configure the auth environment variables accordingly. You can use this with any command that requires Swift credentials, e.g. `./testing/with-saio.sh swift stat`. |