CONTRIBUTING.md

Contributing

Prerequisites

What things you need to setup the project:

• go
• ginkgo

Environment

For start developing the SDK you must clone the project:

git clone git@github.com:lab259/hermes.git

Now, the dependencies must be installed.

go mod download

😉 Finally, you are done to start developing.

Running tests

In the root directory (where you can find a file named Makefile), execute:

make test

To enable coverage, execute:

make coverage

To generate the HTML coverage report, execute:

make coverage coverage-html

Running examples

In the root directory, execute:

make $EXAMPLE run

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