minio/CONTRIBUTING.md

Setup your Minio Github Repository

Fork Minio upstream source repository to your own personal repository. Copy the URL and pass it to go get command. Go uses git to clone a copy into your project workspace folder.

$ mkdir -p $GOPATH/src/github.com/minio-io
$ cd $GOPATH/src/github.com/minio-io
$ git clone https://github.com/$USER_ID/minio
$ cd minio

Compiling Minio from source

Minio uses Makefile to wrap around some of the limitations of go build system. To compile Minio source, simply change to your workspace folder and type make.

$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
Installed godep
Installed cover
Building Libraries
...
...

Setting up git remote as upstream

$ cd $GOPATH/src/github.com/minio-io/minio
$ git remote add upstream https://github.com/minio-io/minio
$ git fetch upstream
$ git merge upstream/master
...
...
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
Installed godep
Installed cover
Building Libraries
...

Developer Guidelines

Minio community welcomes your contribution. To make the process as seamless as possible, we ask for the following:

• Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.

  • Fork it
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create new Pull Request

• If you have additional dependencies for Minio, Minio manages its depedencies using godep

  • Run go get foo/bar
  • Edit your code to import foo/bar
  • Run make save from top-level directory (or godep restore && godep save ./...).

• When you're ready to create a pull request, be sure to:

  • Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
  • Run `go fmt
  • Run golint

  $ go get github.com/golang/lint/golint $ golint ./...

  - Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
  - Make sure `go test -race ./...` and `go build` completes.
  

• Read Effective Go article from Golang project

  • Minio project is strictly conformant with Golang style
  • if you happen to observe offending code, please feel free to send a pull request