Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
felipemfp committed Jul 3, 2019
1 parent 3db3b37 commit 3c1fb89
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,27 @@
What things you need to setup the project:

- [go](https://golang.org/doc/install)
- [golang/dep](https://github.com/golang/dep)
- [ginkgo](http://onsi.github.io/ginkgo/)

### Environment

For start developing the SDK you must create a fake `GOPATH` structure:

```
+-- /
|---- src
|------ github.com
|-------- lab259
|---------- http <- Here is where you will clone this repository.
```

Use the following command:
For start developing the SDK you must clone the project:

```bash
mkdir -p src/github.com/lab259/hermes && git clone [email protected]:lab259/hermes.git src/github.com/lab259/hermes
git clone [email protected]:lab259/hermes.git
```

Now, the dependencies must be installed.

```
cd src/github.com/lab259/hermes && make dep-ensure
```bash
go mod download
```

:wink: Finally, you are done to start developing.

### Running tests

In the `src/github.com/lab259/hermes` directory, execute:
In the root directory (where you can find a file named `Makefile`), execute:

```bash
make test
Expand All @@ -56,10 +45,10 @@ make coverage coverage-html

### Running examples

In the `src/github.com/lab259/hermes` directory, execute:
In the root directory, execute:

```bash
EXAMPLE="todos" make run
make $EXAMPLE run
```

`EXAMPLE` is any example listed in `/examples` folder.
`$EXAMPLE` is any example listed in `/examples` folder (eg.: `make todos run`)

0 comments on commit 3c1fb89

Please sign in to comment.