Minio community welcomes your contribution. To make the process as seamless as possible, we recommend you read this contribution guide.
Start by forking the Minio GitHub repository, make changes in a branch and then send a pull request. We encourage pull requests to discuss code changes. Here are the steps in details:
Setup your Minio GitHub Repository
Fork Minio upstream source repository to your own personal repository. Copy the URL of your Minio fork (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 minio
Set up git remote as
$ cd $GOPATH/src/github.com/minio/minio $ git remote add upstream https://github.com/minio/minio $ git fetch upstream $ git merge upstream/master ...
Create your feature branch
Before making code changes, make sure you create a separate branch for these changes
$ git checkout -b my-new-feature
Test Minio server changes
After your code changes, make sure
- To add test cases for the new code. If you have questions about how to do it, please ask on our Slack channel.
- To run
- To squash your commits into a single commit.
git rebase -i. It's okay to force update your pull request.
- To run
go test -race ./...and
After verification, commit your changes. This is a great post on how to write useful commit messages
$ git commit -am 'Add some feature'
Push to the branch
Push your locally committed changes to the remote origin (your fork)
$ git push origin my-new-feature
Create a Pull Request
Pull requests can be created via GitHub. Refer to this document for detailed steps on how to create a pull request. After a Pull Request gets peer reviewed and approved, it will be merged.
Minio manages dependencies?
Minio manages its dependencies using govendor. To add a dependency
go get foo/bar
- Edit your code to import foo/bar
make pkg-add PKG=foo/barfrom top-level directory
To remove a dependency
- Edit your code to not import foo/bar
make pkg-remove PKG=foo/barfrom top-level directory