From c304f4a3833538462331c262e8237a461d74bc33 Mon Sep 17 00:00:00 2001 From: Yeh-lei Wu Date: Tue, 26 Feb 2019 21:04:49 +0800 Subject: [PATCH 1/2] Document tool setup and e2e test detail in Contributing.md Signed-off-by: Yeh-lei Wu --- docs/CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 8c01ba9c07..acf62034c0 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: From 442963da9a0fc2bbc8a869973487a29dc51ae33d Mon Sep 17 00:00:00 2001 From: Yeh-lei Wu Date: Tue, 26 Feb 2019 21:07:36 +0800 Subject: [PATCH 2/2] Fix typo in contribution guide --- docs/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index acf62034c0..06fc1ba6c1 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -139,7 +139,7 @@ You can get the e2e test report from the log of testing pod: $ kubectl -n=tidb-operator-e2e logs -f tidb-operator-e2e ``` -To re-run e2e tests, delete the testing pod and apply it again: +To re-run e2e tests, delete the testing pod and apply it again. ### Step 5: Keep your branch in sync