minio/CONTRIB.md
2014-12-20 09:09:35 -08:00

1.1 KiB

Contribution Guidelines

We welcome your contributions. 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.