Skip to content

Commit 38739fc

Browse files
committed
docs(contributing): fix links and build tool list
* Fix a couple of broken links related to code styling and linting * Add `jq` and `xz` to the list of build tools (needed when running `make verify`) * Add links to the website of all the listed build tools Signed-off-by: Jay Vercellone <[email protected]>
1 parent a37bee0 commit 38739fc

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

CONTRIBUTING.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,17 @@ Follow the steps below to set up the environment:
9595
- [Clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
9696
- Install Go by following [installation](https://go.dev/doc/install). Please check the minimal go version in [go.mod file](./go.mod#L3).
9797
- 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`
101109
- Verify that everything is installed by running `make build`
102110

103111
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
124132
## Implement your change
125133

126134
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.
128136

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/)):
130139
- `make verify` to verify if all checks pass.
131140
- `make verify-*` to verify a single check, for example, `make verify-bom` to verify if `bill-of-materials.json` file is up-to-date.
132141
- `make fix` to fix all checks.

0 commit comments

Comments
 (0)