minio/DEVELOPER.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.

$ git clone https://github.com/$USER_ID/minio
$ cd minio
$ mkdir -p ${GOPATH}/src/github.com/minio-io
$ ln -s ${PWD} $GOPATH/src/github.com/minio-io/

Compiling Minio from source

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

$ cd $GOPATH/src/github.com/$USER_ID/minio/
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
...
...
Installed minio into /home/userid/work/minio/gopath/bin
Installed new-cmd into /home/userid/work/minio/gopath/bin

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
  • Squash your commits into a single commit. git rebase -i. It's okay to force update your pull request.
  • Make sure go test -race ./... passes, and go build completes.