Skip to content

Commit 581c0cb

Browse files
authored
Merge pull request #352 from interma/improve_contri
improve contributing guide
2 parents d0f783b + 347b377 commit 581c0cb

File tree

1 file changed

+27
-30
lines changed

1 file changed

+27
-30
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
## Sign the CLA
44

55
Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests.
6-
Please see https://git.k8s.io/community/CLA.md for more info
76

8-
### Contributing A Patch
7+
Please see https://git.k8s.io/community/CLA.md for more info.
8+
9+
## Contributing steps
910

1011
1. Submit an issue describing your proposed change to the repo in question.
1112
1. The [repo owners](OWNERS) will respond to your issue promptly.
@@ -15,31 +16,29 @@ Please see https://git.k8s.io/community/CLA.md for more info
1516

1617
## How to build kubebuilder locally
1718

18-
Setup:
19-
20-
- Download [google container builder](https://cloud.google.com/container-builder/docs/build-debug-locally)
21-
- Export `OUTPUT` to a location to write the directory containing the final build artifacts
22-
23-
```sh
24-
export OUTPUT=/tmp/kubebuilder
25-
```
26-
27-
Run container-builder:
28-
29-
```sh
30-
container-builder-local --config=build/cloudbuild_local.yaml --dryrun=false \
31-
--write-workspace=$OUTPUT .
32-
```
33-
34-
Extract `tar.gz` from $OUTPUT to /usr/local
35-
36-
## Running kubebuilder tests
37-
38-
```sh
39-
go test ./pkg/...
40-
```
41-
42-
## Community, discussion, contribution, and support
19+
1. Setup tools
20+
1. Download and setup [gcloud](https://cloud.google.com/sdk/docs/downloads-interactive)
21+
1. Install `cloud-build-local` via `gcloud`
22+
```bash
23+
$ gcloud install cloud-build-local
24+
```
25+
1. Build
26+
1. Export `OUTPUT` to a location to write the directory containing the final build artifacts
27+
```sh
28+
$ export OUTPUT=/tmp/kubebuilder
29+
```
30+
2. Run container-builder:
31+
```sh
32+
$ cloud-build-local --config=build/cloudbuild_local.yaml --dryrun=false \
33+
--write-workspace=$OUTPUT .
34+
```
35+
1. Extract `tar.gz` from $OUTPUT to /usr/local
36+
1. Test
37+
```sh
38+
go test ./pkg/...
39+
```
40+
41+
## Community, discussion and support
4342

4443
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
4544

@@ -48,8 +47,6 @@ You can reach the maintainers of this project at:
4847
- [Slack](http://slack.k8s.io/)
4948
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-kubebuilder)
5049

51-
### Code of conduct
50+
## Code of conduct
5251

5352
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
54-
55-
[google container builder]: https://github.com/kubernetes-sigs/container-builder-local

0 commit comments

Comments
 (0)