Update DEVELOPER.md

master
Harshavardhana 10 years ago
parent 62d56f4a62
commit 024b3a29d3
  1. 9
      DEVELOPER.md

@ -21,15 +21,14 @@ Installed minio into /home/userid/work/minio/gopath/bin
Installed new-cmd into /home/userid/work/minio/gopath/bin Installed new-cmd into /home/userid/work/minio/gopath/bin
``` ```
### Developer Guidelines ### Developer Guidelines
``Minio`` community welcomes your contribution. To make the process as seamless as possible, we ask for the following:
``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. * Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
- Fork it - Fork it
- Create your feature branch (git checkout -b my-new-feature) - Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature') - Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature) - Push to the branch (git push origin my-new-feature)
- Create new Pull Request - Create new Pull Request
* If you have additional dependencies for ``minio``, ``minio`` manages its depedencies using [godep](https://github.com/tools/godep) * If you have additional dependencies for ``Minio``, ``Minio`` manages its depedencies using [godep](https://github.com/tools/godep)
- Run `go get foo/bar` - Run `go get foo/bar`
- Edit your code to import foo/bar - Edit your code to import foo/bar
- Run `make save` from top-level directory (or `godep restore && godep save ./...`). - Run `make save` from top-level directory (or `godep restore && godep save ./...`).
@ -38,4 +37,6 @@ Installed new-cmd into /home/userid/work/minio/gopath/bin
- Run `go fmt` - Run `go fmt`
- Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. - 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. - Make sure `go test -race ./...` and `go build` completes.
* Make sure read Golang's [Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) article, `Minio` project is strictly conformant with this style - if you happen to see an offending code, please feel free to send a pull request * 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

Loading…
Cancel
Save