Skip to content

Commit 256df03

Browse files
Morven Caoibm-ci-bot
Morven Cao
authored andcommitted
add more details for dev doc. (IBM#33)
* add more details for dev doc. Signed-off-by: llcao <[email protected]> * fix linter. Signed-off-by: llcao <[email protected]>
1 parent 99ca58d commit 256df03

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

Diff for: docs/development.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,28 @@
2121
| [prototool](https://github.com/uber/prototool/blob/dev/docs/install.md) | `7df3b95` |
2222
| [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) | `3792095` |
2323

24-
- Setup GIT_HOST to override the setting for your custom path (e.g. github.com/<myaccount>)
24+
## Developer quick start
25+
26+
- Setup `GIT_HOST` to override the setting for your custom path.
27+
28+
```bash
29+
export GIT_HOST=github.com/<YOUR_GITHUB_ID>
30+
```
31+
32+
- Run the `linter` and `test` before building the binary.
33+
34+
```bash
35+
make check
36+
make test
37+
make build
38+
```
39+
40+
- Build and push the docker image for local development.
41+
42+
```bash
43+
export IMG=<YOUR_CUSTOMIZED_IMAGE_NAME>
44+
export REGISTRY=<YOUR_CUSTOMIZED_IMAGE_REGISTRY>
45+
make build-push-images
46+
```
47+
48+
> **Note:** You need to login the docker registry before running the command above.

0 commit comments

Comments
 (0)