minio/CONTRIBUTING.md at 826202716f8650cea58b8bc976bc0ff953fd1125

mirror of https://github.com/minio/minio.git synced 2024-12-25 22:55:54 -05:00

Harshavardhana 61175ef091 Migrate to govendor to avoid limitations of godep

- over the course of a project history every maintainer needs to update
  its dependency packages, the problem essentially with godep is manipulating
  GOPATH - this manipulation leads to static objects created at different locations
  which end up conflicting with the overall functionality of golang.

  This also leads to broken builds. There is no easier way out of this other than
  asking developers to do 'godep restore' all the time. Which perhaps as a practice
  doesn't sound like a clean solution. On the other hand 'godep restore' has its own
  set of problems.

- govendor is a right tool but a stop gap tool until we wait for golangs official
  1.5 version which fixes this vendoring issue once and for all.

- govendor provides consistency in terms of how import paths should be handled unlike
  manipulation GOPATH.

  This has advantages
    - no more compiled objects being referenced in GOPATH and build time GOPATH
      manging which leads to conflicts.
    - proper import paths referencing the exact package a project is dependent on.

 govendor is simple and provides the minimal necessary tooling to achieve this.

 For now this is the right solution.

2015-08-12 19:24:57 -07:00

2.6 KiB

Raw Blame History

Install Golang

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

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.

$ mkdir -p $GOPATH/src/github.com/minio
$ cd $GOPATH/src/github.com/minio
$ git clone https://github.com/$USER_ID/minio
$ cd minio

Compiling Minio from source

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

$ 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/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 depedencies using govendor
- Run go get foo/bar
- Edit your code to import foo/bar
- Run govendor add 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

2.6 KiB Raw Blame History