akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update contribution guidelines with newest proto repos

Browse Source
This commit is contained in:
Olaoluwa Osuntokun 2017-08-22 00:09:11 -07:00
parent 129a0e10de
commit 2b411051e1
No known key found for this signature in database
GPG Key ID: 9CC5B105D03521A2
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/code_contribution_guidelines.md
View File

@ -348,9 +348,14 @@ The `lnd` project uses `protobuf`, and its extension [`gRPC`](www.grpc.io) in
several areas and as the primary RPC interface. In order to ensure uniformity several areas and as the primary RPC interface. In order to ensure uniformity
of all protos checked, in we require that all contributors pin against the of all protos checked, in we require that all contributors pin against the
_exact same_ version of `protoc`. As of the writing of this article, the `lnd` _exact same_ version of `protoc`. As of the writing of this article, the `lnd`
project uses [v3.2.0](https://github.com/google/protobuf/releases/tag/v3.2.0) project uses [v3.4.0](https://github.com/google/protobuf/releases/tag/v3.4.0)
of `protoc`. of `protoc`.
The following commit hashes of related projects are also required in order to
generate identical compiled protos and related files:
* grpc-ecosystem/grpc-gateway: f2862b476edcef83412c7af8687c9cd8e4097c0f
* golang/protobuf: ab9f9a6dab164b7d1246e0e688b0ab7b94d8553e
Additionally, in order to maintain a uniform display of the RPC responses Additionally, in order to maintain a uniform display of the RPC responses
rendered by `lncli`, all added or modified `protof` definitions, _must_ attach rendered by `lncli`, all added or modified `protof` definitions, _must_ attach
the proper `json_name` option for all fields. An example of such an option can the proper `json_name` option for all fields. An example of such an option can