21 lines
887 B
Markdown
21 lines
887 B
Markdown
|
# How to contribute
|
||
|
|
|
||
|
|
Thank you for your contribution to grpc-gateway.
|
||
|
|
Here's the recommended process of contribution.
|
||
|
|
|
||
|
|
1. `go get github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway`
|
||
|
|
2. `cd $GOPATH/src/github.com/grpc-ecosystem/grpc-gateway`
|
||
|
|
3. hack, hack, hack...
|
||
|
|
4. Make sure that your change follows best practices in Go
|
||
|
|
* [Effective Go](https://golang.org/doc/effective_go.html)
|
||
|
|
* [Go Code Review Comments](https://golang.org/wiki/CodeReviewComments)
|
||
|
|
5. Make sure that `make test` passes. (use swagger-codegen 2.1.6, not newer versions)
|
||
|
|
6. Sign [a Contributor License Agreement](https://cla.developers.google.com/clas)
|
||
|
|
7. Open a pull request in Github
|
||
|
|
|
||
|
|
When you work on a larger contribution, it is also recommended that you get in touch
|
||
|
|
with us through the issue tracker.
|
||
|
|
|
||
|
|
### Code reviews
|
||
|
|
All submissions, including submissions by project members, require review.
|