CONTRIBUTING.md (1340B)
1 ### Developer Guidelines 2 3 ``minio-go`` welcomes your contribution. To make the process as seamless as possible, we ask for the following: 4 5 * Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes. 6 - Fork it 7 - Create your feature branch (git checkout -b my-new-feature) 8 - Commit your changes (git commit -am 'Add some feature') 9 - Push to the branch (git push origin my-new-feature) 10 - Create new Pull Request 11 12 * When you're ready to create a pull request, be sure to: 13 - Have test cases for the new code. If you have questions about how to do it, please ask in your pull request. 14 - Run `go fmt` 15 - Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. 16 - Make sure `go test -race ./...` and `go build` completes. 17 NOTE: go test runs functional tests and requires you to have a AWS S3 account. Set them as environment variables 18 ``ACCESS_KEY`` and ``SECRET_KEY``. To run shorter version of the tests please use ``go test -short -race ./...`` 19 20 * Read [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project 21 - `minio-go` project is strictly conformant with Golang style 22 - if you happen to observe offending code, please feel free to send a pull request