Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document tool setup and e2e test detail in Contributing.md #288

Merged
merged 3 commits into from
Feb 27, 2019
Merged

Document tool setup and e2e test detail in Contributing.md #288

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c304f4a
Document tool setup and e2e test detail in Contributing.md
aylei Feb 26, 2019
442963d
Fix typo in contribution guide
aylei Feb 26, 2019
34e1127
Merge branch 'master' into issue-287
weekface Feb 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down