@@ -6,6 +6,14 @@ Kubernetes projects require that you sign a Contributor License Agreement (CLA)
6
6
7
7
Please see https://git.k8s.io/community/CLA.md for more info.
8
8
9
+ ## Prerequisites
10
+ - [ go] ( https://golang.org/dl/ ) version v1.12+.
11
+ - [ dep] ( https://github.com/golang/dep ) dep v0.5.1+ < v.0.5.4
12
+ - [ docker] ( https://docs.docker.com/install/ ) version 17.03+.
13
+ - [ kubectl] ( https://kubernetes.io/docs/tasks/tools/install-kubectl/ ) version v1.11.3+.
14
+ - [ kustomize] ( https://sigs.k8s.io/kustomize/docs/INSTALL.md ) v3.1.0+
15
+ - Access to a Kubernetes v1.11.3+ cluster.
16
+
9
17
## Contributing steps
10
18
1 . Submit an issue describing your proposed change to the repo in question.
11
19
1 . The [ repo owners] ( OWNERS ) will respond to your issue promptly.
@@ -15,9 +23,17 @@ Please see https://git.k8s.io/community/CLA.md for more info.
15
23
16
24
## How to build kubebuilder locally
17
25
26
+ 1 . Run the following command to clone your fork of the project locally in the dir /src/sigs.k8s.io/kubebuilder
27
+
28
+ ```
29
+ $ git clone git@github.com:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebuilder
30
+ ```
31
+
18
32
1 . Ensure you activate module support before continue (` $ export GO111MODULE=on ` )
19
- 1 . Build the project by using the command ` make build `
20
- 1 . Run the tests by using the command ` make test ` and ` make test-project-generation `
33
+ 1 . Build the project by using the command ` make build `
34
+ 1 . Run the tests by using the command ` make test `
35
+ 1 . Run the command ` make install ` to create a bin with the source code
36
+ 1 . Run the script ` ./generated_golden.sh ` to update/generate the mock data used in the e2e test in ` $GOPATH/src/sigs.k8s.io/kubebuilder/testdata/ `
21
37
22
38
## Community, discussion and support
23
39
0 commit comments