2014-12-29 19:35:56 -05:00
### Setup your Minio Github Repository
Fork [Minio upstream ](https://github.com/Minio-io/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.
```sh
$ git clone https://github.com/$USER_ID/minio
$ cd minio
```
### Compiling Minio from source
2015-02-02 00:18:46 -05: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-29 19:35:56 -05:00
```sh
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
2015-02-02 00:18:46 -05:00
Installed godep
Installed cover
Building Libraries
2014-12-29 19:35:56 -05:00
...
...
```
2015-02-02 00:18:46 -05:00
2014-12-29 19:35:56 -05:00
### Developer Guidelines
2014-12-30 20:45:17 -05:00
``Minio`` community welcomes your contribution. To make the process as seamless as possible, we ask for the following:
2014-12-29 19:35:56 -05:00
* 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
2014-12-30 20:45:17 -05:00
* If you have additional dependencies for ``Minio``, ``Minio`` manages its depedencies using [godep ](https://github.com/tools/godep )
2014-12-29 19:35:56 -05:00
- 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.
2014-12-30 20:42:09 -05:00
- 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 ./...` and `go build` completes.
2014-12-30 20:45:17 -05:00
* Read [Effective Go ](https://github.com/golang/go/wiki/CodeReviewComments ) article from Golang project
- `Minio` project is strictly conformant with Golang style
- if you happen to observe offending code, please feel free to send a pull request