@@ -95,9 +95,17 @@ Follow the steps below to set up the environment:
95
95
- [ Clone the repository] ( https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository )
96
96
- Install Go by following [ installation] ( https://go.dev/doc/install ) . Please check the minimal go version in [ go.mod file] ( ./go.mod#L3 ) .
97
97
- Install build tools:
98
- - ` make ` : For Debian-based distributions you can run ` sudo apt-get install build-essential `
99
- - ` protoc ` : You can download it for your os. Use version [ ` v3.20.3 ` ] ( https://github.com/protocolbuffers/protobuf/releases/tag/v3.20.3 ) .
100
- - ` yamllint ` : For Debian-based distribution you can run ` sudo apt-get install yamllint `
98
+ - [ ` make ` ] ( https://www.gnu.org/software/make/ ) : For Debian-based distributions
99
+ you can run ` sudo apt-get install build-essential `
100
+ - [ ` protoc ` ] ( https://protobuf.dev/ ) : You can download it for your os. Use
101
+ version
102
+ [ ` v3.20.3 ` ] ( https://github.com/protocolbuffers/protobuf/releases/tag/v3.20.3 ) .
103
+ - [ ` yamllint ` ] ( https://www.yamllint.com/ ) : For Debian-based distribution you
104
+ can run ` sudo apt-get install yamllint `
105
+ - [ ` jq ` ] ( https://jqlang.github.io/jq/ ) : For Debian-based distribution you can
106
+ run ` sudo apt-get install jq `
107
+ - [ ` xz ` ] ( https://tukaani.org/xz/ ) : For Debian-based distribution you can run
108
+ ` sudo apt-get install xz-utils `
101
109
- Verify that everything is installed by running ` make build `
102
110
103
111
Note: ` make build ` runs with ` -v ` . Other build flags can be added through env ` GO_BUILD_FLAGS ` , ** if required** . Eg.,
@@ -124,9 +132,10 @@ A codespace will open in a web-based version of Visual Studio Code. The [dev con
124
132
## Implement your change
125
133
126
134
etcd code should follow the coding style suggested by the Golang community.
127
- See the [ style doc] ( https://github.com/golang/go /wiki/CodeReviewComments ) for details.
135
+ See the [ style doc] ( https://go.dev /wiki/CodeReviewComments ) for details.
128
136
129
- Please ensure that your change passes static analysis (requires [ golangci-lint] ( https://golangci-lint.run/usage/install/ ) ):
137
+ Please ensure that your change passes static analysis (requires
138
+ [ golangci-lint] ( https://golangci-lint.run/welcome/install/ ) ):
130
139
- ` make verify ` to verify if all checks pass.
131
140
- ` make verify-* ` to verify a single check, for example, ` make verify-bom ` to verify if ` bill-of-materials.json ` file is up-to-date.
132
141
- ` make fix ` to fix all checks.
0 commit comments