Skip to content

Latest commit

 

History

History
71 lines (61 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

71 lines (61 loc) · 2.71 KB
Raw

Install Golang

If you do not have a working Golang environment setup please follow Golang Installation Guide.

Setup your Minfs Github Repository

Fork MinIO upstream 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).

$ mkdir -p $GOPATH/src/github.com/minio
$ cd $GOPATH/src/github.com/minio
$ git clone <paste saved URL for personal forked minio repo>
$ cd minfs

Compiling MinIO from source

MinIO uses Makefile to wrap around some of redundant checks done through command line.

$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for MinIO.. Done
Installed govet
Building Libraries
...
...

Setting up git remote as upstream

$ cd $GOPATH/src/github.com/minio/minfs
$ git remote add upstream https://github.com/minio/minfs
$ 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

    • 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 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