### Install Golang If you do not have a working Golang environment setup please follow [Golang Installation Guide](https://docs.minio.io/docs/how-to-install-golang). ### Setup your Minio Github Repository Fork [Minio upstream](https://github.com/minio/minio/fork) source repository to your own personal repository. Copy the URL for minio from your personal github repo (you will need it for the `git clone` command below). ```sh $ mkdir -p $GOPATH/src/github.com/minio $ cd $GOPATH/src/github.com/minio $ git clone $ cd minio ``` ### Compiling Minio from source Minio uses ``Makefile`` to wrap around some of redundant checks done through command line. ```sh $ make Checking if proper environment variables are set.. Done ... Checking dependencies for Minio.. Done Installed govet Building Libraries ... ... ``` ### Setting up git remote as ``upstream`` ```sh $ cd $GOPATH/src/github.com/minio/minio $ git remote add upstream https://github.com/minio/minio $ git fetch upstream $ git merge upstream/master ... ... $ make Checking if proper environment variables are set.. Done ... Checking dependencies for Minio.. Done Installed govet 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 dependencies using [govendor](https://github.com/kardianos/govendor) - Run `go get foo/bar` - Edit your code to import foo/bar - Run `make pkg-add PKG=foo/bar` from top-level directory * If you have dependencies for ``Minio`` which needs to be removed - Edit your code to not import foo/bar - Run `make pkg-remove PKG=foo/bar` from top-level directory * 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 `make verifiers` - 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](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project - `Minio` project is fully conformant with Golang style - if you happen to observe offending code, please feel free to send a pull request