minio/CONTRIBUTING.md

68 lines
2.6 KiB
Markdown
Raw Normal View History

2014-12-29 19:35:56 -05:00
### Setup your Minio Github Repository
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-29 19:35:56 -05:00
```sh
2015-05-11 19:23:10 -04:00
$ mkdir -p $GOPATH/src/github.com/minio
$ cd $GOPATH/src/github.com/minio
2014-12-29 19:35:56 -05:00
$ 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``.
2014-12-29 19:35:56 -05:00
```sh
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
Installed godep
Installed cover
Building Libraries
2014-12-29 19:35:56 -05:00
...
...
```
2015-02-18 17:35:49 -05:00
### Setting up git remote as ``upstream``
```sh
2015-05-11 19:23:10 -04:00
$ cd $GOPATH/src/github.com/minio/minio
$ git remote add upstream https://github.com/minio/minio
2015-02-18 17:35:49 -05:00
$ git fetch upstream
$ git merge upstream/master
...
...
$ make
Checking if proper environment variables are set.. Done
...
Checking dependencies for Minio.. Done
Installed godep
Installed cover
Building Libraries
...
```
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.
2015-02-09 16:34:19 -05: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
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)
2015-02-09 16:34:19 -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 ./...`).
2014-12-29 19:35:56 -05:00
* When you're ready to create a pull request, be sure to:
2015-02-09 16:34:19 -05:00
- Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
2015-03-06 00:09:16 -05:00
- Run `go fmt
- Run `golint`
```
$ go get github.com/golang/lint/golint
$ golint ./...
```
2015-02-09 16:34:19 -05: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.
2014-12-30 20:45:17 -05:00
* Read [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project
2015-02-09 16:34:19 -05:00
- `Minio` project is strictly conformant with Golang style
- if you happen to observe offending code, please feel free to send a pull request