2015-05-28 03:41:14 +02:00
### Install Golang
If you do not have a working Golang environment setup please follow [Golang Installation Guide ](./INSTALLGO.md ).
2014-12-30 01:35:56 +01:00
### Setup your Minio Github Repository
2015-05-12 01:43:38 +02:00
Fork [Minio upstream ](https://github.com/minio/minio/fork ) 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.
2014-12-30 01:35:56 +01:00
```sh
2015-05-12 01:23:10 +02:00
$ mkdir -p $GOPATH/src/github.com/minio
$ cd $GOPATH/src/github.com/minio
2014-12-30 01:35:56 +01:00
$ git clone https://github.com/$USER_ID/minio
$ cd minio
```
### Compiling Minio from source
2015-02-02 06:18:46 +01:00
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``.
2014-12-30 01:35:56 +01:00
```sh
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
2015-08-13 04:24:31 +02:00
Installed govet
2015-02-02 06:18:46 +01:00
Building Libraries
2014-12-30 01:35:56 +01:00
...
...
```
2015-02-02 06:18:46 +01:00
2015-02-18 23:35:49 +01:00
### Setting up git remote as ``upstream``
```sh
2015-05-12 01:23:10 +02:00
$ cd $GOPATH/src/github.com/minio/minio
$ git remote add upstream https://github.com/minio/minio
2015-02-18 23:35:49 +01:00
$ git fetch upstream
$ git merge upstream/master
...
...
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
2015-08-13 04:24:31 +02:00
Installed govet
2015-02-18 23:35:49 +01:00
Building Libraries
...
```
2014-12-30 01:35:56 +01:00
### Developer Guidelines
2014-12-31 02:45:17 +01:00
``Minio`` community welcomes your contribution. To make the process as seamless as possible, we ask for the following:
2014-12-30 01:35:56 +01:00
* Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
2015-02-09 22:34:19 +01:00
- 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
2015-08-13 04:24:31 +02:00
* If you have additional dependencies for ``Minio``, ``Minio`` manages its depedencies using [govendor ](https://github.com/kardianos/govendor )
2015-02-09 22:34:19 +01:00
- Run `go get foo/bar`
- Edit your code to import foo/bar
2015-08-23 07:23:36 +02:00
- 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
2015-08-13 04:24:31 +02:00
2014-12-30 01:35:56 +01:00
* When you're ready to create a pull request, be sure to:
2015-02-09 22:34:19 +01:00
- Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
2015-08-13 04:24:31 +02:00
- Run `make verifiers`
2015-02-09 22:34:19 +01:00
- 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.
2015-08-13 04:24:31 +02:00
2014-12-31 02:45:17 +01:00
* Read [Effective Go ](https://github.com/golang/go/wiki/CodeReviewComments ) article from Golang project
2015-08-13 04:24:31 +02:00
- `Minio` project is fully conformant with Golang style
2015-02-09 22:34:19 +01:00
- if you happen to observe offending code, please feel free to send a pull request