You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 lines
2.1 KiB
40 lines
2.1 KiB
10 years ago
|
### 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
|
||
|
|
$ mkdir -p ${GOPATH}/src/github.com/minio-io
|
||
|
|
$ ln -s ${PWD} $GOPATH/src/github.com/minio-io/
|
||
|
|
```
|
||
|
|
|
||
|
|
### Compiling Minio from source
|
||
|
|
Minio uses ``Makefile`` to wrap around some of the limitations of ``go build``. To compile Minio source, simply change to your workspace folder and type ``make``.
|
||
|
|
```sh
|
||
|
|
$ make
|
||
|
|
Checking if proper environment variables are set.. Done
|
||
|
|
...
|
||
|
|
Checking dependencies for Minio.. Done
|
||
|
|
...
|
||
|
|
...
|
||
|
|
```
|
||
|
|
### Developer Guidelines
|
||
|
10 years ago
|
``Minio`` community welcomes your contribution. To make the process as seamless as possible, we ask for the following:
|
||
|
10 years ago
|
* 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
|
||
|
10 years ago
|
* If you have additional dependencies for ``Minio``, ``Minio`` manages its depedencies using [godep](https://github.com/tools/godep)
|
||
|
10 years ago
|
- 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.
|
||
|
10 years ago
|
- 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.
|
||
|
10 years ago
|
* 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
|