From 4e83f89efe8445b50f14c7aeaae71c25fdb71a85 Mon Sep 17 00:00:00 2001 From: Yeh-lei Wu Date: Wed, 27 Feb 2019 10:27:35 +0800 Subject: [PATCH] Document tool setup and e2e test detail in Contributing.md (#288) * Document tool setup and e2e test detail in Contributing.md --- docs/CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8c01ba9c07b..06fc1ba6c1f 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -96,6 +96,14 @@ $ git checkout -b myfeature ### Step 4: Develop +#### Setup + +Make sure all the related tools are properly installed. + +```sh +$ make check-setup +``` + #### Edit the code You can now edit the code on the `myfeature` branch. @@ -125,6 +133,14 @@ After Docker images are pushed to the DinD Docker registry, run e2e tests: $ kubectl apply -f manifests/tidb-operator-e2e.yaml ``` +You can get the e2e test report from the log of testing pod: + +```sh +$ kubectl -n=tidb-operator-e2e logs -f tidb-operator-e2e +``` + +To re-run e2e tests, delete the testing pod and apply it again. + ### Step 5: Keep your branch in sync While on your `myfeature` branch, run the following commands: