Skip to content
Permalink
Browse files

doc(CONTRIBUTING.md) : improvements and add tests info

  • Loading branch information
camilamacedo86 committed Nov 14, 2019
1 parent 971cf03 commit 8f1f81f8cf3633888dbe84231c46c00b038dbf3e
Showing with 12 additions and 1 deletion.
  1. +12 −1 CONTRIBUTING.md
@@ -31,10 +31,21 @@ $ git clone git@github.com:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu

1. Ensure you activate module support before continue (`$ export GO111MODULE=on`)
1. Build the project by using the command `make build`
1. Run the tests by using the command `make test`
1. Run the command `make install` to create a bin with the source code

## How to test kubebuilder locally

1. Run the tests by using the command `make test`. It will execute unit tests.
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/`

**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.

## Where the CI Tests are configured?

1. See the [Travis](.travis.yml) file to check its tests and the scripts used on it.
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).
1. Check that all scripts used by the CI are defined in the project.

## Community, discussion and support

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

0 comments on commit 8f1f81f

Please sign in to comment.
You can’t perform that action at this time.