Skip to content

Commit 814dadb

Browse files
authored
Merge pull request #1199 from camilamacedo86/doc-tests
📖 (CONTRIBUTING.md) : improvements and add tests info
2 parents 0742025 + 8f1f81f commit 814dadb

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,21 @@ $ git clone [email protected]:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu
3131

3232
1. Ensure you activate module support before continue (`$ export GO111MODULE=on`)
3333
1. Build the project by using the command `make build`
34-
1. Run the tests by using the command `make test`
3534
1. Run the command `make install` to create a bin with the source code
35+
36+
## How to test kubebuilder locally
37+
38+
1. Run the tests by using the command `make test`. It will execute unit tests.
3639
1. Run the script `make generate` to update/generate the mock data used in the e2e test in `$GOPATH/src/sigs.k8s.io/kubebuilder/testdata/`
3740

41+
**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.
42+
43+
## Where the CI Tests are configured?
44+
45+
1. See the [Travis](.travis.yml) file to check its tests and the scripts used on it.
46+
1. Note that the prow tests used in the CI are configured in [kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
47+
1. Check that all scripts used by the CI are defined in the project.
48+
3849
## Community, discussion and support
3950

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

0 commit comments

Comments
 (0)