From 2e49b519289fced1ab46e62b6f758cc73d0f7d68 Mon Sep 17 00:00:00 2001 From: David Xia Date: Wed, 3 Jul 2024 10:58:04 -0400 Subject: [PATCH] docs: clarify English prose in CONTRIBUTING.md with more conventional choice of words and sentence structure. These are all minor readability improvements. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c03000437..8dd61dd7f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ $ git clone git@github.com:/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu - e2e tests use [`kind`][kind] and [`setup-envtest`][setup-envtest]. If you want to bring your own binaries, place them in `$(go env GOPATH)/bin`. -**IMPORTANT:** The `make generate` is very helpful. By using it, you can check if good part of the commands still working successfully after the changes. Also, note that its usage is a pre-requirement to submit a PR. +**IMPORTANT:** The `make generate` is very helpful. By using it, you can check if good part of the commands still working successfully after the changes. Also, note that its usage is a prerequisite to submit a PR. Following the targets that can be used to test your changes locally. @@ -67,7 +67,7 @@ Following the targets that can be used to test your changes locally. | make check-testdata | Checks if the testdata dir is updated with the latest changes | yes | | make test-e2e-local | Runs the CI e2e tests locally | no | -**NOTE** To use the `make lint` is required to install `golangci-lint` locally. More info: https://github.com/golangci/golangci-lint#install +**NOTE** `make lint` requires a local installation of `golangci-lint`. More info: https://github.com/golangci/golangci-lint#install ### Running e2e tests locally